Generating Docs logo

Generating Docs

Community
telagod
generating-docs

Generates README.md and DESIGN.md scaffolds by analyzing module structure. Use when creating documentation templates for new modules. Automatically triggered at module creation.

Overview

Publishertelagod
Repositorycode-abyss
Skill namegenerating-docs
Stars
242
Forks
33
Bundled files
2
LicenseMIT
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • 2 bundled files

    Scripts, templates, and references the model can read while it works. Files are read-only and never executed.

  • Open source

    Published by telagod on GitHub. Read the source before you install it.

Installation

Install the Generating Docs AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/telagod/code-abyss/tree/main/skills/generating-docs
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/telagod/code-abyss.git /tmp/code-abyss
mkdir -p .claude/skills
cp -r /tmp/code-abyss/skills/generating-docs .claude/skills/generating-docs
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Generating Docs in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Generating Docs on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Generating Docs is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

造典关卡 · 文档生成器

生成的是骨架,不是答案。填决策理由是人的工作,工具不能代劳。

何时使用

场景跑理由
新模块创建后第一时间✅趁记忆新鲜填决策
verifying-modules 报「缺 README/DESIGN」✅直接补救
重构后边界变化⚠看是否要重生成或手动改;不要 --force 覆盖已有内容
已有完整文档❌不要破坏人工写的内容

生成内容

README.md(自动可填部分)

字段自动来源待人补
模块名目录名是否有更好的展示名
描述顶级 docstring(Python)「存在理由」必须人写
特性TODO(占位)列 3–5 个核心能力
依赖requirements.txt / package.json / Cargo.toml 等是否有运行时假设
使用方法TODO(占位)5 分钟跑通示例
API 概览公开类/函数签名调用顺序、生命周期
目录结构tree 输出—

DESIGN.md(骨架占位)

字段自动待人补(最重要)
设计目标 / 非目标TODO核心决策驱动力
架构TODO含一张图最好
核心组件公开类/函数列表各组件的协作关系
决策表TODO方案对比 + 选择理由
技术选型依赖列表选 X 不选 Y 的理由
权衡TODO牺牲了什么
安全考量TODO信任边界、威胁模型

语言支持

语言提取深度
Python类、函数、docstring、依赖(最完整)
Go / TypeScript / Rust目录结构 + 依赖
其他基础目录结构

流程

doc_generator.js 生成骨架
        ↓
人工填 TODO(决策理由、使用示例、非目标)
        ↓
verify-module 校验完整性
        ↓
通过则提交

何时不要 --force

  • 目标文件已有人工内容 —— --force 会无差别覆盖。先 diff 旧版,手动合并。
  • CI 环境 —— 生成应在开发机做,CI 只校验,不生成。

与其他 skill 联动

使用

bash
node scripts/doc_generator.js <模块路径>
node scripts/doc_generator.js <模块路径> --force   # 强制覆盖(慎用)
node scripts/doc_generator.js <模块路径> --json    # CI 用

收口

工具给骨架,TODO 不补完不算交付。生成后 5 分钟内人工填决策;超过 1 天会忘原因,文档质量陡降。

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Generating Docs AI skill do?

Generates README.md and DESIGN.md scaffolds by analyzing module structure. Use when creating documentation templates for new modules. Automatically triggered at module creation.

Why use Generating Docs on TypingMind?

Because you install it once and use it with any model. Generating Docs is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Generating Docs in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/telagod/code-abyss/tree/main/skills/generating-docs. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Generating Docs?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Generating Docs?

As many as you like. As long as a model supports skills, you can use Generating Docs with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Generating Docs AI skill free?

Yes. It is published on GitHub by telagod under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇