...
A simple cultural shift is to add documentation as a part of our code review process as well as add bullets on our tasks to include updating documentation. It won’t happen overnight but we can make an honest effort to do better moving forwards.
TL;DR:
On new stories, put acceptance criteria to update readme or confluence as applicable.
...
Document as if we are an enterprise and need new hires up to speed quickly.
FAQs
| Expand | ||
|---|---|---|
| ||
Is it up to date? Yes? Then, update the date on the Readme “Date last Modified” to today’s date. If it isn’t up to date, update it. If you are reviewing someone else's code and it’s not up to date, don’t approve the PR until it is! |
...
| Code Block |
|---|
# APPLICATION NAME Date Created: 8/14/22 Date Last Modified: 8/14/22 Description: Tell me what the application does? Who does it do it for? How do they benefit? What makes it special? Table of Contents: - [Index item 1](#example1) - [index item 2](#example2) ... ## Tech stack - Single page application made in React.js ## Example 1 - Features ## Example 1 - local installation steps - Do thing 1 - Do thing 2 ## Important notes: > This is a note for new hires ## 🔗 Relevant links - [link1](https://example.com) ## Runbook Symptom: "thing happens" Solution: "Do thing" |
Confluence Format
Fair game! Make it full of pictures, screenshots, gifs. Make it readable. But most importantly, if it could be in a readme because it applies to code, link it one way or the other.
...