doc-smith-docs-detail

Generate detailed documents from document structure, user intent, and source code analysis.

163|134|Updated Jul 29, 2025
One-click install
npx skills add https://github.com/AIGNE-io/aigne-doc-smith --skill doc-smith-docs-detail
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-smith-docs-detail
Source: https://github.com/AIGNE-io/aigne-doc-smith/tree/main/skills/doc-smith-docs-detail
Command: npx skills add https://github.com/AIGNE-io/aigne-doc-smith --skill doc-smith-docs-detail

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

doc-smith-docs-detail 能基于文档结构和用户意图,自动生成单个文档的详细内容,并提供导航、代码示例和技术图表,提升文档质量与产出速度。

Core Features & Use Cases

  • 从 planning/document-structure.yaml、intent/user-intent.md 和 config.yaml 等源读取信息,确定文档范围、语言与结构。
  • 分析源代码中的 API、类定义、函数签名与配置项,提炼核心概念以支撑文档内容。
  • 生成带导航的文档结构(前置条件、父主题、相关主题、下一步、子文档),并在需要处包含代码示例与图表。
  • 根据需要生成或复用技术图表并通过 AFS image slots 标记,对最终文档进行保存前的校验。
  • 支持自定义需求,通过 saveDocument 进行保存,并使用 checkContent 进行内容校验,返回摘要。

Quick Start

提供目标文档路径以及可选的自定义需求,系统将生成、校验并保存详细文档。

Frequently Asked Questions about doc-smith-docs-detail

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate detailed documentation from source code and intent?

Generate detailed documentation by combining document structure, user intent, and source code analysis. The system analyzes API definitions, class signatures, and config files to produce documents with navigation, code examples, and technical diagrams.

Can I automate code analysis to produce documents with navigation and diagrams?

Yes, automated code analysis extracts APIs, classes, and function signatures to produce documents with built-in navigation, code examples, and technical diagrams marked via AFS image slots for visual referencing.

How does document structure validation work before saving generated docs?

Document validation runs a checkContent process to verify structure and content integrity before saving. The system applies the full workflow to plan, generate, validate, and save the document, returning a structured summary with validation results.

Does the documentation generation support language localization from config files?

Yes, language localization is applied by reading configurations directly from config.yaml. This ensures the generated detailed document matches the specified language settings defined in your configuration file.

What do I need to provide to generate a single detailed document?

You need to provide a target document path and optional custom requirements. The system reads document-structure.yaml, user-intent.md, and config.yaml to determine scope, language, and structure for the output document.

When should I use an automated workflow for detailed document generation?

Use an automated workflow when you need to transform complex source code analysis into structured documents with navigation, examples, and diagrams. It ensures consistent validation and localization across multiple detailed technical documents.