wehub-resource-sync
1 line
4.5 KiB
JSON
1 line
4.5 KiB
JSON
{"content": "---\nallowed-tools: Read, Write, Edit, Bash\nargument-hint: [doc-type] | --implementation | --api | --architecture | --sync | --validate\ndescription: Systematically update project documentation with implementation status, API changes, and synchronized content\n---\n\n# Documentation Update & Synchronization\n\nUpdate project documentation systematically: $ARGUMENTS\n\n## Current Documentation State\n\n- Documentation structure: !`find . -name \"*.md\" | head -10`\n- Specs directory: @specs/ (if exists)\n- Implementation status: !`grep -r \"✅\\|❌\\|⚠️\" docs/ specs/ 2>/dev/null | wc -l` status indicators\n- Recent changes: !`git log --oneline --since=\"1 week ago\" -- \"*.md\" | head -5`\n- Project progress: @CLAUDE.md or @README.md (if exists)\n\n## Task\n\n## Documentation Analysis\n\n1. Review current documentation status:\n - Check `specs/implementation_status.md` for overall project status\n - Review implemented phase document (`specs/phase{N}_implementation_plan.md`)\n - Review `specs/flutter_structurizr_implementation_spec.md` and `specs/flutter_structurizr_implementation_spec_updated.md`\n - Review `specs/testing_plan.md` to ensure it is current given recent test passes, failures, and changes\n - Examine `CLAUDE.md` and `README.md` for project-wide documentation\n - Check for and document any new lessons learned or best practices in CLAUDE.md\n\n2. Analyze implementation and testing results:\n - Review what was implemented in the last phase\n - Review testing results and coverage\n - Identify new best practices discovered during implementation\n - Note any implementation challenges and solutions\n - Cross-reference updated documentation with recent implementation and test results to ensure accuracy\n\n## Documentation Updates\n\n1. Update phase implementation document:\n - Mark completed tasks with ✅ status\n - Update implementation percentages\n - Add detailed notes on implementation approach\n - Document any deviations from original plan with justification\n - Add new sections if needed (lessons learned, best practices)\n - Document specific implementation details for complex components\n - Include a summary of any new troubleshooting tips or workflow improvements discovered during the phase\n\n2. Update implementation status document:\n - Update phase completion percentages\n - Add or update implementation status for components\n - Add notes on implementation approach and decisions\n - Document best practices discovered during implementation\n - Note any challenges overcome and solutions implemented\n\n3. Update implementation specification documents:\n - Mark completed items with ✅ or strikethrough but preserve original requirements\n - Add notes on implementation details where appropriate\n - Add references to implemented files and classes\n - Update any implementation guidance based on experience\n\n4. Update CLAUDE.md and README.md if necessary:\n - Add new best practices\n - Update project status\n - Add new implementation guidance\n - Document known issues or limitations\n - Update usage examples to include new functionality\n\n5. Document new testing procedures:\n - Add details on test files created\n - Include test running instructions\n - Document test coverage\n - Explain testing approach for complex components\n\n## Documentation Formatting and Structure\n\n1. Maintain consistent documentation style:\n - Use clear headings and sections\n - Include code examples where helpful\n - Use status indicators (✅, ⚠️, ❌) consistently\n - Maintain proper Markdown formatting\n\n2. Ensure documentation completeness:\n - Cover all implemented features\n - Include usage examples\n - Document API changes or additions\n - Include troubleshooting guidance for common issues\n\n## Guidelines\n\n- DO NOT CREATE new specification files\n- UPDATE existing files in the `specs/` directory\n- Maintain consistent documentation style\n- Include practical examples where appropriate\n- Cross-reference related documentation sections\n- Document best practices and lessons learned\n- Provide clear status updates on project progress\n- Update numerical completion percentages\n- Ensure documentation reflects actual implementation\n\nProvide a summary of documentation updates after completion, including:\n1. Files updated\n2. Major changes to documentation\n3. Updated completion percentages\n4. New best practices documented\n5. Status of the overall project after this phase"} |