Skip to content
Folder Structure Guidelines logo

Folder Structure Guidelines

Explain folder structure strategy and rules to respect all over any realization.

SKILL.md

Full skill instructions

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 into the folder /​docs of project folder
  • All specifications files must be into the folder /​docs/​specs of project folder
  • All design specifications files must be into the folder /​docs/​specs/​design of project folder
  • All technical and architectural specifications files must be into the folder /​docs/​specs/​architecture of project folder
  • All functional and product specification files must be into the folder /​docs/​specs/​product of project folder
  • All testing specification files must be into the folder /​docs/​specs/​testing of project folder
  • All tests must be into the folder "/​tests" of project folder

Keep project folder structure clear and compliant to thoses rules conversational.