swactor/docs/DOCUMENTING.md

7 lines
462 B
Markdown
Raw Normal View History

When requested to document your changes:
- read the `docs/` folder
- summarize your changes and add them to the `docs/development_history`
- use the extant files as a guide for how you should write the document
- add a section `verifying` that shows how a user can verify the changes work as expected
- check the relevant md and svg files in `docs` and add any changes
- add new docs to the folder if necessary, but do not clutter