Skip to main content
doc-generator-output-templates 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.
الانتقال إلى التثبيت سوق المهارات اكتشف واستكشف مهارات الذكاء الاصطناعي التي بناها المجتمع.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
عرض تفاصيل Prompt يتجاوز الأمر المباشر Prompt المخصّص للمراجعة. افحص المصدر قبل تشغيله.
npx skills add https://github.com/gravity9-tech/claude_code_marketplace_demo --skill doc-generator-output-templatesيبقى الأمر في سطر واحد. مرّر أفقيًا لمراجعته كاملًا قبل النسخ.
تفضّل نسخة محلية؟ نزّل الملفات المتاحة حاليًا لدى SkillsMP.
تحميل Zip جاري التحميل... المزيد من هذا المستودع codebase-analysis-patterns 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.
documentation-quality-checklist 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-patterns 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.
المهن ذات الصلة SOC
استنادا إلى تصنيف SOC المهني
name doc-generator-output-templates description 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. user-invocable false
Doc Generator Output Templates
Response formats and error templates for the deepwiki-doc-generator agent.
Response Structure
All responses follow this JSON structure:
{
"status" : "success | partial | failed" ,
"page_path" : "relative/path/to/page.md" ,
"file_written" : true ,
"file_location" : "/absolute/path/to/wiki/relative/path/to/page.md" ,
"file_size_bytes" : 4521 ,
"metadata" : { ... } ,
"warnings"
:
[
]
,
"sections_generated"
:
[
]
}
Status Values Status Meaning Use When successAll operations completed File written, all diagrams generated partialCompleted with issues Some diagrams failed, missing source files failedCould not complete Invalid input, file write error
Success Response {
"status" : "success" ,
"page_path" : "architecture/system-architecture.md" ,
"file_written" : true ,
"file_location" : "/path/to/wiki/architecture/system-architecture.md" ,
"file_size_bytes" : 4521 ,
"metadata" : {
"generated_at" : "2026-01-22T10:30:00Z" ,
"word_count" : 1247 ,
"section_count" : 5 ,
"code_blocks" : 3 ,
"diagrams_generated" : 2 ,
"diagrams" : [
{
"type" : "c4-context" ,
"title" : "System Context" ,
"status" : "generated" ,
"lines" : 12
} ,
{
"type" : "c4-container" ,
"title" : "Container Architecture" ,
"status" : "generated" ,
"lines" : 18
}
] ,
"external_links" : 5 ,
"internal_links" : 8 ,
"evidence_sources" : [
"app/main.py:1-50" ,
"docker-compose.yml" ,
"package.json"
]
} ,
"warnings" : [ ] ,
"sections_generated" : [
"System Context and Scope" ,
"Architectural Layers" ,
"Major Components" ,
"Technology Stack Overview" ,
"Key Design Decisions"
]
}
Metadata Schema {
"metadata" : {
"generated_at" : "[ISO timestamp]" ,
"word_count" : "[number]" ,
"section_count" : "[number]" ,
"code_blocks" : "[number]" ,
"diagrams_generated" : "[number]" ,
"diagrams" : [
{
"type" : "[diagram type]" ,
"title" : "[diagram title]" ,
"status" : "generated | failed | skipped" ,
"lines" : "[number of lines]"
}
] ,
"external_links" : "[number]" ,
"internal_links" : "[number]" ,
"evidence_sources" : [ "[file:line references]" ]
}
}
Field Descriptions Field Type Description generated_atstring ISO 8601 timestamp of generation word_countnumber Total words in generated content section_countnumber Number of sections written code_blocksnumber Number of code blocks included diagrams_generatednumber Successfully generated diagrams diagramsarray Details for each diagram external_linksnumber Links to external resources internal_linksnumber Cross-references to other wiki pages evidence_sourcesarray Source files cited in content
Front Matter Template All generated pages include YAML front matter:
---
title: [Page Title ]
description: [Short description ]
generated_at: [ISO timestamp ]
commit: [commit hash if available ]
last_updated: [timestamp ]
word_count: [count ]
diagrams: [count ]
---
Error Responses
Invalid Input Missing or invalid parameters:
{
"status" : "failed" ,
"error" : "Missing required parameter: 'page_path'" ,
"code" : "INVALID_INPUT"
}
File Write Error Cannot write to destination:
{
"status" : "failed" ,
"error" : "Cannot write file: {path}" ,
"code" : "FILE_WRITE_ERROR"
}
Partial Success Responses
Diagram Generation Failure Some diagrams could not be generated:
{
"status" : "partial" ,
"page_path" : "architecture/system-architecture.md" ,
"file_written" : true ,
"metadata" : {
"diagrams_generated" : 1 ,
"diagrams" : [
{
"type" : "c4-context" ,
"title" : "System Context" ,
"status" : "generated" ,
"lines" : 12
} ,
{
"type" : "c4-container" ,
"title" : "Container Architecture" ,
"status" : "failed" ,
"error" : "Insufficient component data"
}
]
} ,
"warnings" : [
"Diagram generation failed for 'c4-container': Insufficient component data" ,
"Proceeding without diagram"
]
}
Source Files Not Found Expected source files missing:
{
"status" : "partial" ,
"page_path" : "architecture/system-architecture.md" ,
"file_written" : true ,
"warnings" : [
"Could not locate expected source files: [patterns]" ,
"Proceeding with available evidence"
]
}
Error Codes Code Meaning Resolution INVALID_INPUTMissing/invalid parameters Check required parameters FILE_WRITE_ERRORCannot write to destination Check permissions and path SITEMAP_NOT_FOUNDCannot read sitemap Verify sitemap_path NO_EVIDENCENo source files found Check source_files patterns
Version: 1.0
Last Updated: 2026-01-22
