write-project-docs SKILL.md skillA
write-project-docs from kihara777/nixkits is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add kihara777/nixkits/write-project-docs@git:20260920.dac80a7Pins git:20260920.dac80a7 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- kihara777/nixkits
- Path
skills/write-project-docs/SKILL.md- Versions recorded
- 9
- Latest version
- git:20260920.dac80a7, committed Sep 20, 2026
- First version recorded
- Jun 23, 2026
- Size
- 16,621 bytes
- Repository stars
- 28
- License
- MIT
按 NixKits 风格为任意项目编写或重新生成完整的多语言文档 — 简洁、表驱动、含语言切换器标题和模块分类 README。覆盖 README、各模块文档及技能文档；含「主仓薄封装 + 子仓完整文档」的迁出组件文档分工与子仓引用关系的显式记录。.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# 项目文档编写（NixKits 风格） 为任意项目生成完整的多语言文档体系。 **主流程在本文档**；配套模板集按需查阅： | 文件 | 内容 | 何时读 | |---|---|---| | **`SKILL.md`**（本文） | 编写规则、双语切换器、自动发现契约、技能文档同步规则 | 始终 | | [`templates.md`](templates.md) | 完整模板集：目录结构、模块文档模板、README 模板、维护日志模板 | 第一次搭建某类文档时 | ## 何时使用 - 用户要求"编写文档"或"生成文档" - 用户希望采用 NixKits 风格（简洁、多语言、表驱动） - 用户有含模块/包/服务的现有项目需要文档化 ## 架构：主仓薄封装 + 子仓完整文档 当主仓中的某个组件**迁出为独立仓库**时，采用这一分工——它避免同一份文档维护两遍： | 位置 | 承载内容 | |------|---------| | **子仓**（独立仓库） | **完整文档**（全部语言）+ 源码。子仓是该项目的事实来源 | | **主仓** | **短页**：说明已迁出、给出子仓链接、**只保留主仓独有的一节**（通常是声明式安装/集成方式），并链向子仓完整文档 | ### 判据：什么组件应当迁出 | 信号 | 说明 | |------|------| | **定位与主仓不符** | 主仓是 Nix flake 合集，而该组件是平台无关的通用软件 | | **有独立的发布渠道** | 需发布到 npm / PyPI / crates.io 等主仓之外的 registry | | **受众不同** | 用户群与主仓用户群不重叠（如非 NixOS 用户） | | **代码层零耦合** | 不 import 主仓内其他包、模块或路径 | ### 短页写法 主仓短页**不得复制**子仓的完整内容（会漂移）。标准结构： ```markdown # <项目名> <语言切换器> <一句话定位> > **本项目已迁出为独立仓库**：<子仓 URL> > > **完整文档（多语）在新仓库内**：<子仓文档 URL> > > 本页只保留<主仓名>独有的一节——**<独有节名>**。 ## 基本信息 （含「源码仓库」「主仓侧角色」等行） ## 安装 ### 方式 A：<子仓原生方式>（如 dsh plugin add / npm install） ### 方式 B：<主仓独有方式>（如声明式） ## <主仓独有的维护说明> ``` 要点： - 基本信息表注明**主仓侧角色**（如「薄封装包」），读者才知两仓关系 - 安装节保留**两种方式**并标注**择一使用**（若二者注册同一标识，同时启用会重复） …
Read the whole file at its exact version.
How to install
mdr add kihara777/nixkits/write-project-docs@sha256:8de42abc9c0e4c35The line at the top of this page pins the label git:20260920.dac80a7, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_37nolssq6hwwfhf3)
3 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 9 versions of this file, between Jun 23, 2026 and Sep 20, 2026, about one every 11 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260920.dac80a7 latest | 2026-09-20 | dac80a7 | 16,621 B | A | view · diff |
| git:20260918.7f7363f | 2026-09-18 | 7f7363f | 14,046 B | A | view · diff |
| git:20260917.b7e9717 | 2026-09-17 | b7e9717 | 13,659 B | A | view · diff |
| git:20260916.0760612 | 2026-09-16 | 0760612 | 12,203 B | A | view · diff |
| git:20260721.bb65b77 | 2026-07-21 | bb65b77 | 9,515 B | A | view · diff |
| git:20260721.f597b9a | 2026-07-21 | f597b9a | 9,551 B | A | view · diff |
| git:20260715.6433bac | 2026-07-15 | 6433bac | 9,547 B | A | view · diff |
| git:20260623.da3ccd6 | 2026-06-23 | da3ccd6 | 10,113 B | A | view · diff |
| git:20260623.10f369e | 2026-06-23 | 10f369e | 9,167 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (16621 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
kihara777/nixkits · 28 stars · license MIT · pushed 2026-11-06 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_37nolssq6hwwfhf3 GET https://markdownregistry.com/api/v1/resolve?ref=kihara777/nixkits/write-project-docs GET https://markdownregistry.com/api/v1/blob/8de42abc9c0e4c3529aa5f5094ba8128cf06bf0d269a5e0c075e2b9e547d8f3a
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.