메뉴
Output templates and formatting rules for documentation structure files. Defines the four-section format (Proposed Root, Sitemap, Page Plan, Navigation Rules), front matter schema, and confirmation messages. Use when generating documentation structure output.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
| name | planner-output-templates |
| description | Output templates and formatting rules for documentation structure files. Defines the four-section format (Proposed Root, Sitemap, Page Plan, Navigation Rules), front matter schema, and confirmation messages. Use when generating documentation structure output. |
| user-invocable | false |
Templates and formatting rules for documentation structure files generated by the deepwiki-planner agent.
The documentation structure file contains four sections with front matter:
---
title: Documentation Structure for [Project Name]
generated_at: [ISO timestamp]
commit: [hash if available]
completeness_score: [X]%
total_pages: [count]
---
## 1) Proposed Root
[Content]
## 2) Sitemap (Tree Structure)
[Content]
## 3) Page Plan
[Content]
## 4) Navigation Rules
[Content]
---
Analysis Completeness: [X]%
Missing Sections: [List if any]
Total Pages: [count]
State the root folder path, naming conventions, and versioning rules.
Template:
## 1) Proposed Root
**Root folder:** `wiki/` (or project convention)
**Naming conventions:**
- Folders: `kebab-case`
- Pages: `kebab-case.md`
- Rule: `<area>-<topic>.md` or `<domain>-<feature>.md`
**Version stamp rule:**
Include in front matter of all pages:
```yaml
---
title: Page Title
generated_at: [ISO timestamp]
commit: [hash if available]
---
Rationale: [Explain based on repo size, maturity, team size]
---
## Section 2: Sitemap (ASCII Tree)
Create directory structure using the selected pattern (horizontal, vertical, or hybrid).
**Template:**
```markdown
## 2) Sitemap (Tree Structure)
**Pattern:** [Selected pattern with rationale]
\`\`\`
wiki/
├── README.md
├── overview/
│ ├── system-overview.md
│ ├── technology-stack.md
│ └── glossary.md
├── architecture/
│ ├── system-architecture.md
│ └── patterns.md
├── [domain]/
├── workflows/
├── deployment/
├── security/
├── quality/
└── development/
\`\`\`
**Total pages:** [count]
**Estimated scope:** [Small/Medium/Large]
ASCII Tree Characters:
├── for items with siblings below└── for last item in a directory│ for vertical continuationFor each page in the sitemap, define its purpose, sections, diagrams, and source files.
Template:
## 3) Page Plan
### [Section Name]
#### Page: `path/to/page.md`
**Purpose:** [1-2 sentences: what this page covers and why it matters]
**Required sections:**
- Section 1: [Description]
- Section 2: [Description]
- Code examples: Yes/No
- Tables: Yes/No
**Required diagrams:**
- [c4-context | c4-container | c4-component | sequence | deployment | dfd | activity | class | integration | network]
**Relevant source files:**
- `src/path/to/file.ts` — [Why relevant]
- `src/path/**/*.ts` — [Pattern/folder relevance]
Page Plan Guidelines:
Define how pages interconnect and organize.
Template:
## 4) Navigation Rules
### Index/Hub Page (`README.md`)
**Layout:**
Quick Navigation:
### Breadcrumb Navigation
All pages include: `Home > [Folder] > [Page]`
Example:
```markdown
*[Home](../README.md) > [Architecture](./README.md) > System Architecture*
# System Architecture
...
Folder names match analyzer module/service names (in kebab-case).
Each folder gets README.md with overview, then sub-pages for details.
Always link to related pages using relative paths: [text](../../path/to/page.md)
Include "Last Updated" in front matter: last_updated: [ISO timestamp]
---
## Confirmation Message
After successfully generating the structure file:
✓ Documentation structure generated File: {wiki_location}/.temp/documentation_structure.md Analysis completeness: [X]% Total pages: [count]
Ready for todo list creation and content generation.
---
## Error Message Templates
**Incomplete analysis:**
⚠️ HALT: Codebase analysis incomplete ([X]% completeness). Missing critical sections:
Please review codebase or provide additional context.
**Cannot parse codebase:**
ERROR: Cannot read codebase at {path}
**Ambiguous module naming:**
⚠️ CLARIFY: Found inconsistent module naming. Recommend using kebab-case throughout: user-auth-service
---
**Version:** 1.0
**Last Updated:** 2026-01-22
Comprehensive codebase analysis framework covering 14 technical areas including system overview, architecture, modules, integrations, workflows, and deployment patterns. Use when analyzing a codebase structure for documentation or understanding.
Output templates and response formats for documentation page generation. Defines JSON response structure, metadata schema, and error handling templates. Use when generating documentation pages and returning status.
Quality validation checklist for generated documentation pages. Covers content completeness, evidence backing, markdown syntax, diagram validation, and cross-reference consistency. Use before finalizing any documentation page.
Documentation structure heuristics and sitemap patterns for different codebase types and team sizes. Covers horizontal (concern-based), vertical (domain-based), and hybrid patterns. Use when planning documentation organization.
Evidence-backed documentation patterns with source code citations. Provides guidelines for citing source files, line numbers, and code examples in technical documentation. Use when writing documentation that needs to reference actual code.
ASCII diagram generation skill for creating professional architectural diagrams in text format. Supports C4 models, sequence diagrams, component diagrams, deployment diagrams, data flow diagrams, class diagrams, and integration diagrams for technical documentation.