5 ms·
Docs about code should go in code. That’s what comments and docblocks are. Function signatures should be self-documenting. IMO API documentation is self-defeat
by gshdg 7y ago
Docs about code should go in code. That’s what comments and docblocks are.
Function signatures should be self-documenting. IMO API documentation is self-defeating for a small team because of how quickly it falls out of date.
Docs about design should go into either READMEs or a documentation system. Important trivia like URLs should too. (But don’t document every single URL any more than you document every function signature. Just make sure people know how to get to the staging system and the staff-only admin tools, etc.) Ditto for how-to docs.
Secrets should go into a password manager or something like AWS Secrets Manager.