tech-documentation SKILL.md skillA
This file is byte-identical to the first copy the registry indexed. Same content hash, so the same checks give both the same grade.
tech-documentation from projanvil/mindforge is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add projanvil/mindforge/tech-documentation@git:20261016.6f8a292Pins git:20261016.6f8a292 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- projanvil/mindforge
- Path
plugins/mindforge-zh-cn/skills/tech-documentation/SKILL.md- Versions recorded
- 1
- Latest version
- git:20261016.6f8a292, committed Oct 16, 2026
- Size
- 7,057 bytes
- Repository stars
- 3
- License
- MIT
技术文档编写技能，涵盖 API 文档、架构文档、部署指南和各种技术写作最佳实践。使用此技能创建技术文档、编写 API 文档、创建架构设计文档，或需要部署和运维手册模板时使用。.
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
# 技术文档编写技能 技术文档编写技能库，提供全面的技术文档写作方法论和模板。 ## 何时使用 触发场景：当用户提出以下请求时，使用本 skill： - 当需要编写 API 文档或接口说明时 - 当需要撰写架构设计文档时 - 当用户要求提供部署指南或运维手册模板时 ## 概述 这是一个专注于技术文档编写的综合性技能模块，涵盖各类技术文档的编写规范、模板和最佳实践，帮助团队产出高质量、易理解、易维护的技术文档。 ## 核心能力 ### 1. API文档 - **OpenAPI/Swagger规范** - **RESTful API文档** - **GraphQL文档** - **gRPC接口文档** - **API变更日志** - **认证授权说明** ### 2. 架构文档 - **架构设计文档** (Architecture Design Document) - **架构决策记录** (Architecture Decision Records, ADR) - **系统架构图** (C4模型、UML) - **技术选型报告** - **架构演进路线图** ### 3. 详细设计文档 - **模块设计文档** - **数据库设计文档** - **接口设计文档** - **算法设计说明** - **时序图/流程图** ### 4. 部署运维文档 - **部署手册** - **运维手册** - **故障处理手册** - **监控告警配置** - **性能优化指南** - **备份恢复流程** ### 5. 用户手册 - **产品使用手册** - **快速开始指南** - **常见问题FAQ** - **故障排查指南** - **最佳实践** ### 6. 开发者文档 - **贡献指南** (CONTRIBUTING.md) - **代码规范** - **开发环境搭建** - **测试指南** - **发布流程** ### 7. 项目管理文档 - **项目计划** - **需求文档** - **测试计划** - **发布说明** (Release Notes) - **变更日志** (CHANGELOG) ### 8. 知识库文档 - **技术博客** - **案例分析** - **问题总结** - **学习笔记** ## 文档编写原则 ### 1. 5C原则 - **Clear (清晰)**: 语言简洁，逻辑清晰 - **Concise (简洁)**: 避免冗余，直击要点 - **Complete (完整)**: 信息全面，覆盖所需 - **Correct (正确)**: 内容准确，经过验证 - **Consistent (一致)**: 风格统一，术语规范 ### 2. 读者导向 - 了解目标读者（开发者、运维、产品、用户） …
Read the whole file at its exact version.
How to install
mdr add projanvil/mindforge/tech-documentation@sha256:9928d9e19d1025d7The line at the top of this page pins the label git:20261016.6f8a292, 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_sotowfe42qrqgk3e)
1 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Oct 16, 2026.
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 (7057 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
projanvil/mindforge · 3 stars · license MIT · pushed 2026-10-21 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_sotowfe42qrqgk3e GET https://markdownregistry.com/api/v1/resolve?ref=projanvil/mindforge/tech-documentation GET https://markdownregistry.com/api/v1/blob/9928d9e19d1025d7cca0518b95cfc39783799cec757eb72f20f27034de416da9
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.
More from projanvil/mindforge
Every file in projanvil/mindforge