Re:Ask HN: How To: Internal Documentation?
by nmat on Sunday September 01, 2024 @07:56AM
(#41416185)
And do you go back and update all documents whenever something changes? If you’re swapping people around every month I agree that you must keep everything written down, happens a lot in projects that bring consultants in. But if you have a core team of people and you get 2-3 new people per year then you should be more relaxed about it.
[ Parent
| on HN ]
Re:Ask HN: How To: Internal Documentation?
by codingdave on Sunday September 01, 2024 @10:32AM
(#41417277)
Yep, we do. It is part of the process just like testing. For the most part, it is not painful - most features are variations on existing patterns, and don't need updates. When we do code up a new pattern, we update docs.
And you are correct - we use consultants on the team, and hire in gig workers for small tasks on a regular basis. When I worked on a small core team without much churn, I did not do any of this.