- Add persistent docs: PRD, functional design, architecture, repository structure, development guidelines, milestones - Add brainstorming notes (docs/ideas/) - Configure tooling: package.json, tsconfig, eslint, prettier, vitest - Add opencode configuration (commands, skills, agents) - Add .gitignore for node_modules, .env, data/, backups/, build outputs
3.0 KiB
3.0 KiB
| description | agent |
|---|---|
| Initial setup - interactively create the six persistent documents | build |
Initial Project Setup
This command interactively creates the project's six persistent documents.
How to Run
opencode
> /setup-project
Pre-Run Check
Check the files in the docs/ideas/ directory.
# Check
ls docs/ideas/
# If files exist
✅ Found docs/ideas/initial-requirements.md
The PRD will be created based on its contents
# If no files exist
⚠️ No files found in docs/ideas/
The PRD will be created interactively
Procedure
Step 0: Read the Inputs
- Read all markdown files in
docs/ideas/ - Understand their contents and use them as reference for creating the PRD
Step 1: Create the Product Requirements Document
- Follow the prd-writing skill (loaded automatically) to guide PRD creation
- Create
docs/product-requirements.mdbased on the contents ofdocs/ideas/ - Flesh out the ideas raised during brainstorming:
- Detailed user stories
- Acceptance criteria
- Non-functional requirements
- Success metrics
- Ask the user for confirmation and wait until approved
The subsequent steps are based on the Product Requirements Document, so they are created automatically
Step 2: Create the Functional Design Document
- Follow the functional-design skill (loaded automatically)
- Read
docs/product-requirements.md - Create
docs/functional-design.mdfollowing the skill's template and guide
Step 3: Create the Architecture Design Document
- Follow the architecture-design skill (loaded automatically)
- Read the existing documents
- Create
docs/architecture.mdfollowing the skill's template and guide
Step 4: Create the Repository Structure Document
- Follow the repository-structure skill (loaded automatically)
- Read the existing documents
- Create
docs/repository-structure.mdfollowing the skill's template
Step 5: Create the Development Guidelines
- Follow the development-guidelines skill (loaded automatically)
- Read the existing documents
- Create
docs/development-guidelines.mdfollowing the skill's template
Step 6: Create the Glossary
- Follow the glossary-creation skill (loaded automatically)
- Read the existing documents
- Create
docs/glossary.mdfollowing the skill's template
Completion Criteria
- All six persistent documents have been created
Completion message:
"Initial setup is complete!
Documents created:
✅ docs/product-requirements.md
✅ docs/functional-design.md
✅ docs/architecture.md
✅ docs/repository-structure.md
✅ docs/development-guidelines.md
✅ docs/glossary.md
You are now ready to start development.
How to use going forward:
- Editing documents: just ask in normal conversation
Examples: 'Add a new feature to the PRD', 'Review architecture.md'
- Adding features: run /add-feature [feature name]
Example: /add-feature User authentication
- Document review: run /review-docs [path]
Example: /review-docs docs/product-requirements.md
"