Docs Structure logo

Docs Structure

Community
qshanx
docs-structure

规划、整理或只读审查项目文档结构时使用。按职责聚合同类资料,明确当前主源、历史归档与按需读取入口。

Overview

Publisherqshanx
Repositorydocs-governance
Skill namedocs-structure
Stars
228
Forks
4
Bundled files
Instructions only
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.

  • Self-contained

    Everything the model needs lives in the instructions — no extra files to sync.

  • Open source

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

Installation

Install the Docs Structure 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/qshanx/docs-governance/tree/main/skills/documentation/docs-structure
  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/qshanx/docs-governance.git /tmp/docs-governance
mkdir -p .claude/skills
cp -r /tmp/docs-governance/skills/documentation/docs-structure .claude/skills/docs-structure
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Docs Structure 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 Docs Structure 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 Docs Structure 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.

文档结构

深模块:一个单元围绕清晰职责承载完整能力,将相关复杂细节收在内部。用于文档管理,就是让同一职责的资料集中在一个文件夹或文档中,读者能在这里找到解决该类问题所需的内容;“深”不指目录层级多或篇幅长。

浅接口:用简单入口让使用者知道何时使用、如何进入,无需先了解内部全部细节。用于文档管理,就是入口只说明“解决什么问题、什么时候读、去哪里找”,通过 Markdown 链接指向当前主源,正文按需读取、不在各处复制。

文件夹和单份文档都按这两个原则组织:内部内容完整、职责集中,外部入口简明;根据实际内容决定是否拆分。

流程

  1. 了解现状。 阅读现有入口、文档和相关对话,确认常见任务、资料用途与已有主源,明确本次是规划、整理还是只读审查。

  2. 按职责归类。 盘点全项目文档,将服务同一职责、经常一起查阅或更新的资料放在一起。优先复用已有目录;项目扩大后,若一个目录混入多种职责、相关资料散落多处,或读者需要反复跳转才能找齐资料,再考虑拆分、归并或调整归属。说明调整后各目录负责什么,一份文档能说清时无需拆目录。

  3. 确定主源与入口。 同一主题、同一适用版本只有一份当前有效正文;按已确认的生效与替代关系判断,草稿标明状态,已被替代的资料沿用项目归档位置并注明替代链接,仍受支持的旧版本保留适用范围,不只按日期归档。入口链接当前正文;资料多时设简短索引,少时直接链接。将实际路径交给 agent-entrypoints 接入 Agent 入口与 CLAUDE_MAP.md,说明读取条件,正文只维护一处。

  4. 验证并交付。 用一两个真实任务从入口找到适用正文,检查归属、重复主源、历史误用、断链与多余跳转。规划交付路径、职责和取舍;整理在授权内落实归位、归档及引用更新,保留有效内容与历史;只读审查仅给问题和建议。说明验证结果与缺口。

例子

订单导出的当前 Spec 可放 docs/specs/order-export.md,设计说明放 docs/design/order-export.md,被替代的 Spec 放 docs/specs/archive/ 并链接当前版本。CLAUDE_MAP.md 分别指向需求和设计:“确认导出行为时读 Spec;理解实现方案时读设计说明”。这些是示例路径,采用项目实际目录;文件少时直接链接正文。

Frequently asked questions

What does the Docs Structure AI skill do?

规划、整理或只读审查项目文档结构时使用。按职责聚合同类资料,明确当前主源、历史归档与按需读取入口。

Why use Docs Structure on TypingMind?

Because you install it once and use it with any model. Docs Structure 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 Docs Structure in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/qshanx/docs-governance/tree/main/skills/documentation/docs-structure. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Docs Structure?

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 Docs Structure?

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

Is the Docs Structure AI skill free?

Yes. It is published on GitHub by qshanx 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 👇