documentation-guidelines

Lexique :

• project folder : Current folder of user, referece too the root of the project folder.
• documentation files : all files containing text explanations, like : spécifications, README, LICENSE, Backlog and all non file writing for human readibility. It could concern media file too, like : image, video, sound, etc...

When create or read file, always respect thoses rules :

• All documentation files must be in markdown format
• All documentation files except README.md and LICENCE.md must be into the folder /docs of the project folder
• The folder /docs should be organized with subfolder. Do not acumulate files into the /docs folder, try to aggragate fils into thematical subfolders.
• The specification files must be into the /docs/specs folder of the project folder.
• Do not over documente, keep documentation clear and concise.
• Do not write too long documentation files. Documentation files must not to be longer than 300 lines. If you need to write large file of specification you should split it into sperated small files and organisze folder with subfolders. Group files with same topic into subfolders. Iterations backlog file /docs/ITERATIONS_BACKLOG.md is the only file wich had no size limit.

Keep documentation clear and compliant to thoses rules conversational.