doc-smith-create

Generate and update Markdown documentation from code repositories and text files.

9|Updated Dec 22, 2025
One-click install
npx skills add https://github.com/AIGNE-io/doc-smith-skills --skill doc-smith-create
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-smith-create
Source: https://github.com/AIGNE-io/doc-smith-skills/tree/main/skills/doc-smith-create
Command: npx skills add https://github.com/AIGNE-io/doc-smith-skills --skill doc-smith-create

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the generation and updating of comprehensive documentation from your workspace data sources, including code repositories, text files, and media assets.

Core Features & Use Cases

  • Analyze source code, project structure, and media resources to infer content and plan a clear document structure.
  • Generate organized Markdown documents and a reusable document structure plan; update existing docs and rewrite sections as needed.
  • Support multiple documentation types (technical docs, user guides, API references, tutorials) and handle changeset or PATCH-based modification requests.

Quick Start

Use the doc-smith-create skill to generate English documentation for the current project, for example:

  • /doc-smith-create Generate English documentation for the current project
  • /doc-smith-create 为当前项目生成中文文档

Frequently Asked Questions about doc-smith-create

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

FAQPage Schema
How do I generate technical documentation from my code repository?

To generate technical documentation from a code repository, you need a tool that analyzes source code and project structure to infer content and produce organized Markdown outputs. This Skill automates that process by scanning workspace data sources to plan a clear document structure and generate comprehensive technical docs automatically.

Can I update existing Markdown files using PATCH-based modifications?

Yes, you can update existing Markdown files using PATCH-based modifications. This Skill supports changeset and PATCH-based modification requests, allowing it to rewrite specific sections of existing documents or apply targeted updates without regenerating the entire documentation structure from scratch.

What types of documentation can I create from workspace sources?

You can create multiple documentation types from workspace sources, including technical docs, user guides, API references, and tutorials. By analyzing code repositories, text files, and media assets, the tool infers content to plan and generate structured Markdown outputs tailored to your specific documentation needs.

Does the documentation generator work with media assets in my workspace?

Yes, the documentation generator works with media assets in your workspace. It analyzes code repositories, text files, and media resources to infer content and plan a clear document structure, ensuring that generated Markdown documents incorporate all relevant workspace data sources comprehensively.

What is the best way to structure API references for a project?

The best way to structure API references is to analyze source code and project structure to infer content automatically. This Skill plans a clear document structure and produces organized Markdown outputs, generating comprehensive API references from your workspace data sources without manual formatting effort.

Why generate a reusable document structure plan instead of writing docs directly?

Generating a reusable document structure plan before writing docs directly ensures consistent organization across multiple documentation types. This Skill analyzes your workspace data sources to infer content and produce a reusable plan, enabling organized Markdown outputs that can be updated via changeset or PATCH-based modifications efficiently.