Ask HN: How do you organize software documentation at work? jilles on February 14, 2024 at 08:37 Hacker News: Front Page

Hi folks,

Recently I have ventured into technical writing. At the company I work for, documentation is scattered around ~4 different tools.

1. Google Docs
2. Confluence
3. GitHub (READMEs)
4. Slack

Each of those serves a purpose of course, Google Docs are very collaborative, Confluence is our source of truth, GitHub is mostly for engineering and finally Slack usually has some threads you can find if you run into certain issues.

I am not suggesting we should put all of this into a single tool, but I am wondering if there is a methodology for organizing documentation. I am aware of Diataxis, and want us to use this for certain services / products. What I am looking for in this ASK HN post though, is an overarching methodology of organizing all documentation.

Comments URL: https://news.ycombinator.com/item?id=39370226

Points: 32

# Comments: 39

Leave a Reply

Your email address will not be published. Required fields are marked *