writing-doc SKILL.md skillA
writing-doc from joevilcai666/writing-doc-skill is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add joevilcai666/writing-doc-skill/writing-doc@git:20261015.9630868Pins git:20261015.9630868 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- joevilcai666/writing-doc-skill
- Path
skills/writing-doc/SKILL.md- Versions recorded
- 1
- Latest version
- git:20261015.9630868, committed Oct 15, 2026
- Size
- 5,935 bytes
- Repository stars
- 3
- License
- MIT
编写、改写和审阅技术文档，包括 README、操作指南、教程、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
# Writing Doc 让读者快速找到答案，准确理解内容，并完成任务。以读者的需要决定结构和细节，不为满足写作规则增加负担。 本 skill 主要依据用户提供的《What makes documentation good》。原文标注为归档内容；沿用其写作原则，不把其中的模型、API 或术语示例当作当前技术事实。 ## 先确定读者要解决的问题 - 从请求、现有文档和项目资料判断读者、目标、已有知识与使用场景。仅在缺失信息会明显改变结果时提问。 - 遵循用户指定的语言、范围、格式和风格。修改已有文档时，保留正确事实、必要限定、有效链接和有意设置的结构。 - 优先解决常见且影响大的问题。不要为了覆盖所有读者而加入无关的入门教程或罕见边界情况。 - 根据任务直接写作、改写或审阅。用户只要求审阅时，指出具体问题及改法，不擅自改动文件。 ## 让读者扫读时也能找到答案 - 把答案、结论或关键行动放在文档和章节前面。说明结果时，先给结果，再解释方法。不要用悬念铺垫信息。 - 用标题划分有意义的内容。优先让标题表达具体问题、行动或结论，避免只有“概述”“结果”等抽象名词。保留 API 名称等便于查找的标准标题。 - 对较长、需要跨章节查找的文档提供目录。短文档不必添加目录。 - 让章节和段落的首句独立表达主题。把主题词放在靠前的位置，避免以“在此基础上”“如上所述”开头。 - 保持段落简短，一段只讲一个主题。关键结论可以单独成段。 - 并列信息用列表，顺序操作用编号，比较或对应关系用表格。保留适合连续阅读的解释性段落。 - 有选择地加粗关键结论、条件或行动。不要让整段加粗削弱重点。 ## 降低理解句子的负担 - 使用短句、主动语态和具体动词。删除无用的副词、重复修饰和过渡语，但保留条件、单位与必要限定。 - 在操作步骤中直接说明动作。避免推测读者心理，例如“现在你一定想知道”或“接下来你必须先学会”。 - 优先选择读者能一次理解的句式，不为缩短字数制造歧义。拆开含糊的名词串和过长的修饰语。 - 先交代目的或必要条件，再列出细节。避免让读者读到句末才能知道前面一长串内容的用途。 - 当“这”“它”“上述内容”可能指向多个对象，或需要跨段回忆时，重复具体名称。无需机械删除所有代词。 - 同一概念使用同一名称。统一大小写、标点、文件命名和示例风格，并遵循项目已有约定。 - 保持用户的语言。中文使用自然、明确的中文表达，不套用英语语法和词数限制。 ## 帮助不同背景的读者完成任务 - 用简单语言解释复杂概念，不删掉理解和正确操作所需的技术细节。不要假设某领域的专家也熟悉当前工具链。 - 避免不必要的缩写。需要重复使用的缩写，在首次出现时写出全称并说明含义；保留代码标识符和官方名称。 …
Read the whole file at its exact version.
How to install
mdr add joevilcai666/writing-doc-skill/writing-doc@sha256:b07d36c5e1cfb07dThe line at the top of this page pins the label git:20261015.9630868, 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_zz6imptocyzctyqv)
1 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Oct 15, 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 (5935 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
joevilcai666/writing-doc-skill · 3 stars · license MIT · pushed 2026-10-16 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_zz6imptocyzctyqv GET https://markdownregistry.com/api/v1/resolve?ref=joevilcai666/writing-doc-skill/writing-doc GET https://markdownregistry.com/api/v1/blob/b07d36c5e1cfb07d052fd81547b1b42aa2c15408cd6db975c2dba7ee481aa7c5
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.