Project Onboarding Protocol
1. Directory Structure
Create the following standard hierarchy:
- •
src/: Source code root. - •
scripts/: Local automation and management scripts. - •
docs/en/product/: Feature and requirement documentation. - •
docs/en/legal/: Compliance and legal records. - •
docs/architecture/adr/: Architectural Decision Records.
2. Configuration & Boilerplate Injection
- •README: Create a
README.mdusing the project name from $ARGUMENTS. - •Gitignore: Copy
templates/.gitignore.tmplto.gitignore. - •Changelog: Copy
templates/CHANGELOG.md.tmpltoCHANGELOG.md. - •Automation: Copy the global
doc_manager.pyfrom the skill library toscripts/doc_manager.py.
3. Git & Safety Hooks
- •Initialize: If the directory is not a git repo, run
git init. - •Local Hook: Copy
templates/pre-commit.tmplto.git/hooks/pre-commit. - •Permissions: You MUST run
chmod +x .git/hooks/pre-commit. - •Note: While the Global Hook handles laptop-wide safety, this local hook ensures project-specific scripts like
doc_manager.pyrun even if the global hook is disabled.
4. Documentation Initialization
- •Manifest: Execute
python3 scripts/doc_manager.pyto generate the initialdocs_manifest.json. - •Index: Ensure
docs/README.mdis generated as the Table of Contents.
Definition of Done
- •Standard folders exist.
- •Git is initialized and local hook is executable.
- •
CHANGELOG.mdandREADME.mdare present. - •
docs_manifest.jsonanddocs/README.mdreflect the initial state.