[BP - Documentation] an episode in my BP - Best Practices series #best-practice

best-practices.md

NOTE: Remember to add timestamp to your materials to track progression

List of question/checklist that needs to be answered before making documentations (30/01/24)

https://www.reddit.com/r/ExperiencedDevs/comments/rm3ad2/comment/hpkedo0/?utm_source=share&utm_medium=web2x&context=3

List of documentation for DevOps Engineer (30/01/24)

https://www.reddit.com/r/ExperiencedDevs/comments/rm3ad2/comment/hpkozmy/?utm_source=share&utm_medium=web2x&context=3

Github Wikis are good for small team, encourage devs to update them (30/01/24)

https://www.reddit.com/r/ExperiencedDevs/comments/rm3ad2/comment/hpkte9k/?utm_source=share&utm_medium=web2x&context=3

Tips to design README files that's easy to use and easy to change (30/01/24)

https://www.reddit.com/r/ExperiencedDevs/comments/rm3ad2/comment/hpocaim/?utm_source=share&utm_medium=web2x&context=3

Test as documentation (30/01/24)

https://www.reddit.com/r/ExperiencedDevs/comments/rm3ad2/comment/hpjo85k/?utm_source=share&utm_medium=web2x&context=3

Acceptance Testing, Behavior-Driven Testing, and Gherkin syntax (30/01/24)

https://www.reddit.com/r/ExperiencedDevs/comments/rm3ad2/comment/hpo3xgt/?utm_source=share&utm_medium=web2x&context=3

3 kinds of documentation: Code, Technical, Non-Technical (30/01/24)

https://www.reddit.com/r/ExperiencedDevs/comments/rm3ad2/comment/hpkijp3/?utm_source=share&utm_medium=web2x&context=3

Make writing docs as part of progress, or consider hire someone who solely maintain docs (30/01/24)

https://www.reddit.com/r/ExperiencedDevs/comments/rm3ad2/comment/hplwxnx/?utm_source=share&utm_medium=web2x&context=3