0fcac18357
- Add blog post: 4 Essential Slash Commands I Use in Every Project - Add new slash commands: /doc-refactor, /setup-ci-cd, /unit-test-expand - Update slash-commands README with comprehensive documentation - Simplify /push-all command structure - Archive add-blog-post-slash-commands change - Add blog-post spec and pending openspec changes
25 lines
1.2 KiB
Markdown
25 lines
1.2 KiB
Markdown
---
|
|
name: Documentation Refactor
|
|
description: Restructure project documentation for clarity and accessibility
|
|
tags: documentation, refactoring, organization
|
|
---
|
|
|
|
# Documentation Refactor
|
|
|
|
Refactor project documentation structure adapted to project type:
|
|
|
|
1. **Analyze project**: Identify type (library/API/web app/CLI/microservices), architecture, and user personas
|
|
2. **Centralize docs**: Move technical documentation to `docs/` with proper cross-references
|
|
3. **Root README.md**: Streamline as entry point with overview, quickstart, modules/components summary, license, contacts
|
|
4. **Component docs**: Add module/package/service-level README files with setup and testing instructions
|
|
5. **Organize `docs/`** by relevant categories:
|
|
- Architecture, API Reference, Database, Design, Troubleshooting, Deployment, Contributing (adapt to project needs)
|
|
6. **Create guides** (select applicable):
|
|
- User Guide: End-user documentation for applications
|
|
- API Documentation: Endpoints, authentication, examples for APIs
|
|
- Development Guide: Setup, testing, contribution workflow
|
|
- Deployment Guide: Production deployment for services/apps
|
|
7. **Use Mermaid** for all diagrams (architecture, flows, schemas)
|
|
|
|
Keep docs concise, scannable, and contextual to project type.
|