project-docs-overview SKILL.md skillA
project-docs-overview from ainiaa/skills-project-docs is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add ainiaa/skills-project-docs/project-docs-overview@git:20261103.159a85ePins git:20261103.159a85e in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- ainiaa/skills-project-docs
- Path
skills/project-docs-overview/SKILL.md- Versions recorded
- 4
- Latest version
- git:20261103.159a85e, committed Nov 3, 2026
- First version recorded
- Oct 15, 2026
- Size
- 11,502 bytes
- Repository stars
- 4
- License
- Apache-2.0
从代码和资料生成可追溯的项目、功能、架构和上手文档；按需用 Archify explainer 或零基础图解 HTML，帮助不同背景的读者理解概念、业务规则、技术机制、问题、方案取舍及变更影响。.
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
# Project Docs Overview 生成或修订前按[读者与用途约定](../../references/audience.md)确定需要解释的部分；说明页面也可面向领域专家，不默认使用 ELI5。读者适配保留已选模板、来源与事实口径。 写给需要理解项目或功能的人，而不是把类名和接口列表改写成段落。介绍业务目标与功能时使用 [项目总览模板](assets/project-overview.md)；介绍某项功能或改造时使用 [功能说明模板](assets/feature-description.md)；评估系统当前架构时使用 [架构总览模板](assets/architecture-overview.md)；为新开发者提供安装、运行、测试和排障说明时使用 [开发者上手手册模板](assets/developer-guide.md)。保留所选模板中全部二级章节及顺序，章节内可增加三级标题。资料不足时写明「待确认」或「暂无已知项」，删除空表格和模板提示。用户明确指定其他结构时按其要求。默认交付一份 Markdown；只有用户要求时才发布到飞书或修改目标项目的文档。明确要求按 PDLC 阶段产出时，使用对应 PDLC Skill 及其模板和状态流程。 ## 一页说明与交互 HTML 用户明确要求“一页说明”“做成页面”“explainer”或交互 HTML 时，读取 [explainer 写作与交付规范](references/explainer.md)，按 Archify 3.2.0 的独立 Markdown 契约交付草稿、交互 HTML 与官方回执。继续遵循下方取证和业务核对要求；此模式使用结论与问题面板，不套用固定 Markdown 模板，也不运行 `validate_project_doc.py`。仅画图仍交由 `project-docs-diagram`。未指定页面交付时沿用默认 Markdown。 用户要求“零基础图解”或面向新手的图解页面时，使用同一规范的 ELI5 写作方式：按读者已有知识及解释目标，选择概念关系、业务流程、规则判断、技术机制、问题因果、方案取舍、变更影响、角色培训或客户说明的组织方式，不套用统一流程图。ELI5 不限技术主题，也不表示把成人当儿童。只说“ELI5 解释”“通俗解释”“给业务人员看”是在指定表达方式，默认在当前回答或已选文档中解释；明确要求图解成品或 HTML 时才生成页面。仅有业务材料、没有目标仓库时按该规范的材料取证方式处理，不要求先建仓库或扫描代码。不改变仅画图、产品交互原型及正式文档的既有分工。 ## 取证 先解析本 Skill 目录的真实路径，下文 `../../scripts/` 均相对该目录；安装为软链接时也使用解析后的路径。 …
Read the whole file at its exact version.
How to install
mdr add ainiaa/skills-project-docs/project-docs-overview@sha256:b0adc106d8c0ce86The line at the top of this page pins the label git:20261103.159a85e, 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_kzyradypfbyg5ch3)
0 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 4 versions of this file, between Oct 15, 2026 and Nov 3, 2026, about one every 6 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261103.159a85e latest | 2026-11-03 | 159a85e | 11,502 B | A | view · diff |
| git:20261027.aaa6c55 | 2026-10-27 | aaa6c55 | 10,500 B | A | view · diff |
| git:20261021.43f900b | 2026-10-21 | 43f900b | 10,093 B | A | view · diff |
| git:20261015.789b97f | 2026-10-15 | 789b97f | 9,524 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 (11502 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
ainiaa/skills-project-docs · 4 stars · license Apache-2.0 · pushed 2026-11-04 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_kzyradypfbyg5ch3 GET https://markdownregistry.com/api/v1/resolve?ref=ainiaa/skills-project-docs/project-docs-overview GET https://markdownregistry.com/api/v1/blob/b0adc106d8c0ce86382bd598dfbcfe5980d3e0d9638c049b560eacccd6705be9
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.