technical-writing SKILL.md skillA
technical-writing from jimyag/dotfiles is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add jimyag/dotfiles/technical-writing@git:20261019.0e15234Pins git:20261019.0e15234 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- jimyag/dotfiles
- Path
skills/technical-writing/SKILL.md- Versions recorded
- 8
- Latest version
- git:20261019.0e15234, committed Oct 19, 2026
- First version recorded
- Sep 19, 2026
- Size
- 9,187 bytes
- Repository stars
- 11
- License
- MIT
在起草或重构中文技术设计文档、架构笔记、源码分析、评审稿或工程分享文章，或检查、改写文本的 AI 味、文风、术语和技术文案时使用；先用代码、指标和约束建立论证，再按文档类型或编辑模式加载对应规则。.
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
# 技术写作与文体编辑 把背景、观察、判断、影响和验证讲清楚，让技术同伴能复核结论并继续工作。不要用流畅措辞掩盖证据缺口，也不要把技术文档写成营销稿。 ## 选择模式 先确定交付物，只读取对应参考： | 交付物 | 参考 | | --- | --- | | 设计文档、架构评审、技术决策说明 | [references/design-document.md](references/design-document.md) | | 源码深挖、调用链、语言或系统机制文章 | [references/source-analysis.md](references/source-analysis.md) | | 操作手册、API 流程、故障处理、安全说明 | [references/controlled-instructions.md](references/controlled-instructions.md) | | Hugo 或工程博客文章 | [references/hugo-article.md](references/hugo-article.md) | | 降低 AI 味、按文风润色、检测写作模式、改写技术或界面文案 | [references/style-editing.md](references/style-editing.md) | 短技术说明、评审摘要或架构笔记可直接使用下面的共同流程。只需处理 AI 味、术语或语气而不调整论证结构时，只按 `style-editing` 执行，不启动下面的共同流程。 论文、实验报告或技术文章需要组织实验论证、解释不利结果或处理审稿反馈时，另读 [实验与主张](references/experiments-and-claims.md)。普通操作说明和局部润色不加载此参考。 规划整套产品手册或文档站时，按读者任务组织入门、配置、接口参考和故障处理；只建立实际需要的栏目，并沿用目标仓库的文件命名约定。 ## 共同流程 1. 明确读者、文档类型、要推动的判断和文档覆盖范围。 2. 收集可引用的代码路径、版本、指标、issue/PR、实验和约束。缺失事实能从当前仓库或官方资料确认时先验证，不用想象补齐。 3. 按以下证据链组织内容： `观察 / 代码 / 指标 -> 归纳 -> 判断 -> 实现影响 -> 可观测性 / 验证` 4. 先列章节职责，再写正文。信息之间有依赖关系，章节和段落的顺序要让读者先读到被依赖的内容。每节只承担一个主要问题，删除不能推进事实、论证或操作的段落。改写长文时逐段检查回答的问题、信息增量和依据；清理重复论点与空收尾，先修段落之间的信息推进，再改句式和词语，不为变化打乱步骤或添加旁枝。 …
Read the whole file at its exact version.
How to install
mdr add jimyag/dotfiles/technical-writing@sha256:f620d9e035be12b2The line at the top of this page pins the label git:20261019.0e15234, 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_m2tgusgzfvvmtfvi)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 8 versions of this file, between Sep 19, 2026 and Oct 19, 2026, about one every 4 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261019.0e15234 latest | 2026-10-19 | 0e15234 | 9,187 B | A | view · diff |
| git:20261015.f79eac0 | 2026-10-15 | f79eac0 | 8,977 B | A | view · diff |
| git:20261015.b377f6b | 2026-10-15 | b377f6b | 8,881 B | A | view · diff |
| git:20261010.6ab89ec | 2026-10-10 | 6ab89ec | 7,211 B | A | view · diff |
| git:20261007.c5d3bdc | 2026-10-07 | c5d3bdc | 6,863 B | A | view · diff |
| git:20260924.0d7c84d | 2026-09-24 | 0d7c84d | 6,397 B | A | view · diff |
| git:20260920.878daed | 2026-09-20 | 878daed | 4,115 B | A | view · diff |
| git:20260919.7add278 | 2026-09-19 | 7add278 | 3,737 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 (9187 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
jimyag/dotfiles · 11 stars · license MIT · pushed 2026-10-20 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_m2tgusgzfvvmtfvi GET https://markdownregistry.com/api/v1/resolve?ref=jimyag/dotfiles/technical-writing GET https://markdownregistry.com/api/v1/blob/f620d9e035be12b2acb41a6eb53f499b40942ed4ba855e144ef88def0bf7b653
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.