How to add documentation to your product life cycle

Re:How to add documentation to your product life cycle by candiddevmike on Monday October 09, 2023 @07:58AM (#37819484)

Keep your product documentation in the same repo as the product code and the convenience of being able to update it at the same time will manifest into more up to date documentation. Have the tech writers part of code reviews and rewrite things if necessary.

Don't compartmentalize your product and the documentation for it. Developers don't hate documentation, they hate opening 15 PRs to get shit done.

[ Parent | on HN ]

Re:How to add documentation to your product life cycle by tbragin on Monday October 09, 2023 @09:32AM (#37820300)

Amen, especially for reference documentation, such as API or functions / SQL commands (e.g. for a database product). Those docs should be checked in with the code, and PR should not get merged if the docs are not ready.

[ Parent | on HN ]

Re:How to add documentation to your product life cycle by euroderf on Monday October 09, 2023 @10:46AM (#37820994)

"Docs As Code" is a concept in this space. It mostly assumes the use of Markdown & friends. Then it's probably left to the tech writer(s) to (a) automate the aggregation & assembly processes, and (b) make sure that their edits make it back to the code repos.

AFAIK there's not a nice open source solution (or even toolset) for this.

[ Parent | on HN ]

Re:How to add documentation to your product life cycle by candiddevmike on Monday October 09, 2023 @11:12AM (#37821274)

I use Docsy with great results: https://docsy.dev, e.g. https://github.com/candiddev/homechart/tree/main/hugo/conten...

[ Parent | on HN ]

Re:How to add documentation to your product life cycle by euroderf on Monday October 09, 2023 @04:08PM (#37824846)

Does it (can it) work as something like a CCMS ?

[ Parent | on HN ]