doc-smith-docs-detail

Official

Generate detailed docs from structure and intent.

AuthorAIGNE-io
Version1.0.0
Installs0

System Documentation

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

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

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: doc-smith-docs-detail
Download link: https://github.com/AIGNE-io/aigne-doc-smith/archive/main.zip#doc-smith-docs-detail

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.