Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

We had a team that we were making look bad, and their solution to this problem was to complain about every procedure we weren’t following exactly.

One of the ones I was more sympathetic to was developer docs. We had docs, but not where and in the official file format as required. After dorking around with jcite for a couple weeks I was able to clean up our integration tests enough to work as examples for the docs, and the rest was just rearranging wiki pages into a different set of files.

By the time I was done, I had an almost compliant version of the doc that took our tech writer one hour per release to fix up the company footers and some formatting issues. The rest was handled by a CI/CD job.



Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: