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.

Zur Installation springen

Repository: gravity9-tech/claude_code_marketplace_demo
Letzte Quellaktivität: 9. Februar 2026 um 08:48
Erkannte Sprache von SKILL.md: Englisch
Sterne: 2
Forks: 0

Installationsoptionen

Standardmäßig ist der Prompt ausgewählt, der zuerst die Quelle prüft. Sie können zu einem direkten Befehl wechseln oder eine lokale Kopie herunterladen.

Mit Codex oder Claude installieren Kopieren Sie diesen Prompt, fügen Sie ihn in Codex, Claude oder einen anderen Assistant ein und lassen Sie die Skill-Seite prüfen und installieren.

Ein direkter Befehl überspringt den Prüf-Prompt. Prüfen Sie die Quelle, bevor Sie ihn ausführen.

npx skills add https://github.com/gravity9-tech/claude_code_marketplace_demo --skill doc-generator-output-templates

Der Befehl bleibt in einer Zeile. Scrollen Sie horizontal, um ihn vor dem Kopieren vollständig zu prüfen.

Sie bevorzugen eine lokale Kopie? Laden Sie die Dateien herunter, die SkillsMP derzeit vorliegen.

Quelldateien prüfen

Lesen Sie SKILL.md und alle von SkillsMP angezeigten Begleitdateien, bevor Sie sich für eine Installation entscheiden.

SKILL.md

Quellanweisungen · Schreibgeschützte Vorschau

Zurück zur Suche Zurück zur Installation

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.

2026-02-09

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.

2026-02-09

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.

2026-02-09

Alle aus diesem Repository ansehen

Status	Meaning	Use When
`success`	All operations completed	File written, all diagrams generated
`partial`	Completed with issues	Some diagrams failed, missing source files
`failed`	Could not complete	Invalid input, file write error

{
  "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": {
    "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	Type	Description
`generated_at`	string	ISO 8601 timestamp of generation
`word_count`	number	Total words in generated content
`section_count`	number	Number of sections written
`code_blocks`	number	Number of code blocks included
`diagrams_generated`	number	Successfully generated diagrams
`diagrams`	array	Details for each diagram
`external_links`	number	Links to external resources
`internal_links`	number	Cross-references to other wiki pages
`evidence_sources`	array	Source files cited in content

---
title: [Page Title]
description: [Short description]
generated_at: [ISO timestamp]
commit: [commit hash if available]
last_updated: [timestamp]
word_count: [count]
diagrams: [count]
---

{
  "status": "failed",
  "error": "Missing required parameter: 'page_path'",
  "code": "INVALID_INPUT"
}

{
  "status": "failed",
  "error": "Cannot write file: {path}",
  "code": "FILE_WRITE_ERROR"
}

{
  "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"
  ]
}

{
  "status": "partial",
  "page_path": "architecture/system-architecture.md",
  "file_written": true,
  "warnings": [
    "Could not locate expected source files: [patterns]",
    "Proceeding with available evidence"
  ]
}

Code	Meaning	Resolution
`INVALID_INPUT`	Missing/invalid parameters	Check required parameters
`FILE_WRITE_ERROR`	Cannot write to destination	Check permissions and path
`SITEMAP_NOT_FOUND`	Cannot read sitemap	Verify sitemap_path
`NO_EVIDENCE`	No source files found	Check source_files patterns

doc-generator-output-templates

Installationsoptionen

Quelldateien prüfen