Ask HN: How do you manage your companies knowledge base?

Re:Ask HN: How do you manage your companies knowledge base? by autarchprinceps on Thursday February 17, 2022 @12:42PM (#30376142)

I'm sorry, but documentation is a waste of time. It is never complete, never up to date, never easy to find something in, etc.

Spend the time to make whatever you are doing self describing. Write cleaner code, use infrastructure as code, ci/cd, automatic service overview, proper sprint planing, etc. Anything that improves everyones day to day life, even if they have all the information, experience, etc.

[ Parent | on HN ]

Re:Ask HN: How do you manage your companies knowledge base? by 62951413 on Thursday February 17, 2022 @09:15PM (#30381388)

Have you maintained code bases not written by you much? Have you worked in teams of 10+ people long enough to see people leave the company?

You can never write down too much. Please * write meaningful JIRA descriptions and try to have PRs linked to the ticket * always have a README.md that explains how to build/run/deploy the service * create and maintain a runbook document (another md file?) with frequently used commands and hints at debugging previously observed problems * add comments on class responsibilities and business rules * have a few unit test-like "tests" that make the service execute its main flow

[ Parent | on HN ]