docs: add comprehensive user documentation (README.md)

Implement the add-readme OpenSpec proposal with complete user-facing
documentation covering setup, workflow, and all implemented features.

Documentation includes:
- Framework introduction and feature overview
- Prerequisites (Claude Code required, Pandoc/LaTeX optional)
- Step-by-step setup instructions with profile shortcut
- Complete 12-step workflow (numbered 1-12)
- Detailed commands reference for all 7 slash commands
- Directory structure visualization with explanations
- Maintenance guidance for updates and archiving

Changes from initial draft:
- Removed Quick Start section for simplicity
- Renumbered workflow steps starting from 1 instead of 0
- Removed Example Workflow section to keep documentation concise
- Removed Best Practices section (redundant with workflow guidance)
- Removed Troubleshooting section (detailed help in CLAUDE.md)

All content focuses exclusively on implemented features. No mention of
unimplemented features like automated CV generation.

Closes OpenSpec change: add-readme

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Markus Graf
2025-11-10 15:08:11 +01:00
co-authored by Claude
parent d39be42e81
commit af47ac7663
2 changed files with 462 additions and 11 deletions
+11 -11
View File
@@ -291,17 +291,17 @@ Create comprehensive user-facing documentation in README.md that covers setup, c
- None (documentation only, no code dependencies)
## Verification Checklist
- [ ] README.md exists in repository root
- [ ] Contains all required sections (About, Features, Prerequisites, Setup, Workflow, Commands)
- [ ] Setup instructions are clear and complete
- [ ] All implemented slash commands are documented
- [ ] No references to unimplemented features (e.g., automated CV generation)
- [ ] Examples use realistic scenarios
- [ ] Directory structure reflects actual layout
- [ ] Markdown formatting is correct
- [ ] Links (if any) are valid
- [ ] Documentation is accessible to non-technical users
- [ ] Proofread for typos and clarity
- [x] README.md exists in repository root
- [x] Contains all required sections (About, Features, Prerequisites, Setup, Workflow, Commands)
- [x] Setup instructions are clear and complete
- [x] All implemented slash commands are documented
- [x] No references to unimplemented features (e.g., automated CV generation)
- [x] Examples use realistic scenarios
- [x] Directory structure reflects actual layout
- [x] Markdown formatting is correct
- [x] Links (if any) are valid
- [x] Documentation is accessible to non-technical users
- [x] Proofread for typos and clarity
## Total Estimated Effort
Approximately 3-4 hours for comprehensive documentation.