planning-doc-generator
关于
This skill generates structured project assessment markdown documents from JSON input data. It automatically creates WHY/WHO/WHAT sections and includes a GO/NO-GO decision matrix for project evaluation. Developers should use it when they need to quickly generate planning documentation from structured project data.
技能文档
Planning Document Generator Skill
Purpose
Generate structured assessment documents from JSON configuration. Converts project planning data into markdown assessment reports with purpose, stakeholder, and scope analysis plus a GO/NO-GO decision framework.
When to Use
- Creating project assessment documents
- Generating planning documentation from structured data
- Building evaluation reports with decision matrices
- Documenting project vision and scope
- Creating stakeholder alignment assessments
- Generating baseline project documentation
Input: JSON Format
The skill expects JSON input with the following structure:
{
"project_name": "Project Name",
"date": "2025-11-03",
"why": {
"exists": "Why does this project exist?",
"problem": "What problem does it solve?",
"vision": "What is the desired outcome?"
},
"who": {
"stakeholders": "List of key stakeholders",
"decision_makers": "Who decides",
"executors": "Who does the work",
"concerns": "Their priorities and concerns"
},
"what": {
"building": "What are we building/changing?",
"features": "Key features and components",
"out_of_scope": "What is out of scope",
"success_criteria": "Definition of success"
},
"go_no_go": {
"purpose_clarity": "✓|⚠|✗",
"stakeholder_alignment": "✓|⚠|✗",
"scope_definition": "✓|⚠|✗",
"resource_availability": "✓|⚠|✗",
"timeline_feasibility": "✓|⚠|✗",
"risk_assessment": "✓|⚠|✗",
"success_metrics": "✓|⚠|✗"
},
"decision": "GO|CONDITIONAL|NO-GO",
"rationale": "Explanation of decision"
}
Template Filling Process
- Load
templates/assessment-template.md - Replace all
{PLACEHOLDER}values with JSON data - Calculate coverage: Count non-empty answers ÷ 17 questions
- Insert status indicators (✓/⚠/✗) from GO/NO-GO section
- Generate markdown with formatted decision matrix
- Validate all sections populated with content (no {ANSWER} remaining)
Coverage Calculation
Total question count: 17
Breakdown:
- WHY section: 3 questions
- WHO section: 4 questions
- WHAT section: 4 questions
- GO/NO-GO section: 7 assessment items
- Other: 1 additional (missing info summary)
Formula:
Coverage = (Number of answered/populated fields ÷ 17) × 100
Percentage = Round to nearest whole number
Output Location
Generated documents save to:
~/docs/planning/{project_slug}/assessment-{date}.md
Example:
~/docs/planning/project-name/assessment-2025-11-03.md
Workflow
JSON Input
↓
Load Template
↓
Replace Placeholders
↓
Calculate Coverage
↓
Format Decision Matrix
↓
Validate Completeness
↓
Write to ~/docs/planning/
↓
Markdown Output
Key Features
Status Indicators
- ✓ Green: Ready to proceed
- ⚠ Yellow: Proceed with caution / clarification needed
- ✗ Red: Blocker / do not proceed
Decision Framework
- GO: All indicators green, proceed immediately
- CONDITIONAL GO: Some yellow flags, proceed with mitigation
- NO-GO: Red flags present, do not proceed without resolution
Coverage Tracking
Automatically calculates and displays:
- Number of questions answered (X/17)
- Percentage coverage
- List of missing information
Best Practices
- Complete All Fields: Aim for 100% coverage (17/17)
- Be Specific: Use concrete details, not generic placeholders
- Stakeholder Buy-in: Ensure WHO section reflects actual decision-makers
- Realistic Assessment: Be honest in GO/NO-GO evaluation
- Document Decisions: Clear rationale essential for tracking
Example Usage
# Command-line usage
planning-doc-generator \
--input project-plan.json \
--output ~/docs/planning/myproject/
# Result
~/docs/planning/myproject/assessment-2025-11-03.md
Integration Points
Input Sources
- Project planning worksheets (converted to JSON)
- Kickoff meeting notes (structured into JSON)
- Requirements documents (parsed to JSON format)
- Stakeholder surveys (aggregated to JSON)
Output Consumers
- Project stakeholders (for review/approval)
- Project managers (for tracking)
- Decision makers (for GO/NO-GO calls)
- Documentation archives (for reference)
Validation Rules
Before writing output file:
- All {PLACEHOLDER} values replaced
- No {ANSWER} tokens remaining
- Project name populated
- Date populated (YYYY-MM-DD format)
- Decision field contains valid value (GO, CONDITIONAL, NO-GO)
- Coverage calculated and accurate
Version: 1.0.0 Created: 2025-11-03 Scope: Global utility skill
快速安装
/plugin add https://github.com/matteocervelli/llms/tree/main/planning-doc-generator在 Claude Code 中复制并粘贴此命令以安装该技能
GitHub 仓库
相关推荐技能
go-test
元go-test Skill为Go开发者提供全面的测试指导,涵盖单元测试、性能基准测试和集成测试的最佳实践。它能帮助您正确实现表驱动测试、子测试组织、mock接口和竞态检测,同时指导测试覆盖率分析和性能基准测试。当您编写_test.go文件、设计测试用例或优化测试策略时,这个Skill能确保您遵循Go语言的标准测试惯例。
issue-documentation
元该Skill为开发者提供标准化的issue文档模板和指南,适用于创建bug报告、GitHub/Linear/Jira问题等场景。它能系统化地记录问题状况、复现步骤、根本原因、解决方案和影响范围,确保团队沟通清晰高效。通过实施主流问题跟踪系统的最佳实践,帮助开发者生成结构完整的故障排除文档和事件报告。
llamaindex
元LlamaIndex是一个专门构建RAG应用的开发框架,提供300多种数据连接器用于文档摄取、索引和查询。它具备向量索引、查询引擎和智能代理等核心功能,支持构建文档问答、知识检索和聊天机器人等数据密集型应用。开发者可用它快速搭建连接私有数据与LLM的RAG管道。
business-rule-documentation
元该Skill为开发者提供标准化的业务规则和领域知识文档模板,遵循领域驱动设计原则。它能系统化地捕获业务规则、流程、决策树和术语表,确保业务需求与技术实现的一致性。适用于创建领域模型、业务规则库、流程映射,以及改善业务与技术团队之间的沟通。
