DEV Community

Discussion on: What is your default documentation process?

Collapse
 
acutesoftware profile image
Duncan Murray

README.md = what the software should do from a users point of view

doc/requirements.md = clarify and expand of the list all the user requirements. Move ones I wont do to section "Phase 2"

doc/design.md = how I am going to make the software. Notes here on environment details, tricky code bits, database schema.

tests/*.py = have a unit or integration test for each of the requirements

I like to keep everything in a text only format, and dont always to all the above but generally I'll stick to it. (even if it is a single line of text in one of the files)