Technical Writing

Use when drafting or revising internal technical design docs, review notes, architecture writeups, or sharing posts in Chinese, especially when the tone should stay evidence-backed, calm, and suitable for peers or leaders rather than marketing or literary writing.

217 stars 11 forksWriting & Content

Install

skills CLI (Claude Code, Cursor, Codex and more)

npx skills add luoling8192/technical-writing --skill technical-writing

Manual install

git clone --depth 1 https://github.com/luoling8192/technical-writing.git /tmp/technical-writing
mkdir -p ~/.claude/skills
cp -r /tmp/technical-writing/. ~/.claude/skills/technical-writing

Personal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.

From the SKILL.md

# Internal Technical Writing

## Overview

Use this skill when the writing target is an internal技术方案、评审稿、架构说明、分享文稿，重点在于把背景、猜想、证据、抽象、实现影响面讲清楚。

这类写作更接近技术汇报，不是宣传稿，也不该写成散文。语气要平稳，判断要有来路，段落要能顺着问题往下读。

## When to Use

- 在写内部技术方案、设计说明、评审文档、分享稿
- 在改一篇已经有内容、但文风过满、结论过快、证据不足的技术文章
- 在解释代码、模块边界、架构演进、可观测性、评测方法
- 在把聊天记录、讨论结论整理成可传播的技术文档

**When not to use**

- UI 文案、按钮文案、产品营销稿
- 面向外部用户的帮助文档
- 纯粹的 API reference 或机械说明书

## Core Stance

先接住读者，再往下解释。

常见写法是作者替读者抢先下判断，像 `很清楚`、`说明了`、`显然`、`真正`。这里更适合换成三步：

1. 我们观察到了什么
2. 基于这些观察，可以归纳出什么
3. 这些归纳暂时更适合落在哪类实现或组织方式里

如果要给出更强的判断，至少满足下面任一条件：

- 前文已经提出了对应的猜想，这一段是在 callback
- 同一段上下文里已经有交叉验证的 evidence
- 已经引用了具体模块、代码、issue、trace、指标或实验结果

这些 bad case 往往有同一种共性：

- 句子承担的是“主持文章”的功能，不是“推进论证”的功能
- 句子在表达作者感受，不是在交代条件、对象、约束或判断
- 句子把英文抽象写作习惯直接投到了中文里
- 句子删掉以后，不影响事实，不影响论证，也不影响结构

遇到这类句子，默认处理方式不是“换个更文雅的说法”，而是：

1. 先判断这句是否真的提供信息
2. 如果不提供信息，直接删除
3. 如果提供信息，就把信息改写成条件、对象、关系、结果

## Preferred Structure

写长文时，优先用这条主线：

`背景 -> 拆解现状 -> 提出猜想 -> 分节解答 -> 回指前文 -> 影响面 -> 可观测性 / eval -> 收束`

如果文章围绕一个系统展开，可以把每一节都写成“在回答前面哪个问题”。这样读者会知道当前段落在解决什么，而不是只看到一串观点。

更具体一点，常见结构会是：

- 先交代背景和目标
- 拆现状，尤其是已有系统的优势、局限、宏观规律
- 把猜想或设计问题提出来
- 逐节解释每一层能力怎样补上
- 回到代码、模块、数据流、观测面和评测面

如果某一节表面上在讲模块，实际目的是在替另一个概念安家，可以优先用这种结构：

1. 先用一个很短的 quote 收住上下文
2. quote 里优先放 `mindmap` 或极简结构图
3. 再给一个生命周期或时序图
4. 最后才进入正文，解释这个概念为什么放在这里、怎样和现有模块对上

如果要给 leader 或评审一个放在最开头的 TL;DR，优先用三段结构：

1. 先讲启发来源或背景变化
2. 再讲当前系统已经具备哪些输入、还缺哪一层结构
3. 最后讲新模块设计和架构决策

这个 TL;DR 只保留三类信息：

- 原因
- 猜想
- 决策

不要在 TL;DR 里复述整篇目录，也不要解释作者接下来会怎么写。

## Language Rules

Read the full skill on GitHub

Details

Skill name: technical-writing
Repository: luoling8192/technical-writing
License: MIT
Repo updated: 27 May 2026

FAQ

What does the Technical Writing skill do?

How do I install the Technical Writing skill?

skills CLI (Claude Code, Cursor, Codex and more): npx skills add luoling8192/technical-writing --skill technical-writing. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.

Is Technical Writing popular?

It lives in luoling8192/technical-writing, which has 217 GitHub stars and 11 forks.

Related skills

Socialclaw

103

ndesv21/socialclaw

Use when a user wants social media scheduling and publishing for AI agents on X, LinkedIn, Instagram, Facebook Pages, TikTok, Discord, Telegram, YouTube, Reddit, WordPress, and Pinterest through SocialClaw.

Writing & ContentIn 2 lists29

Zero Slop

152

manavmishra/ZeroSlop

Edit drafts into natural prose, inspect AI-sounding patterns, or review how a specified audience might respond passage by passage. Zero Slop runs inside the user's existing AI assistant with local tools that protect source details. Use for humanizing or de-slopping writing, polishing outward-facing prose, social drafts, final editorial checks, or an explicit simulated reader review. Preserve facts, voice and format; reader simulations are hypotheses, not human feedback.

Writing & ContentIn 2 lists

Browser Relay

138

reliefeai/browser-relay

Operate the user's existing, logged-in Chrome locally or on an explicitly connected remote machine. Read complete page content with actionable refs and links, perform grouped actions, and use screenshots in persistent browser sessions. Skip static public pages and pure REST APIs.

Writing & ContentIn 1 list20

Taisly Social Media Posting

222

taisly/agent

Connect AI agents to Taisly through MCP to publish and schedule videos, inspect history, and manage reposts.

Writing & ContentIn 1 list

Xhs Writer

180

JuneYaooo/xhs-writer-skill

生成小红书(RedNote)笔记：把主题或用户提供的素材(文字/图片/视频)做成一套竖版卡片(图文) 或一段带分镜脚本的视频稿(视频)，配 caption + hashtags，落盘到 output/小红书/。使用时机：用户说写小红书 / 做小红书笔记 / 小红书图文 / 小红书种草 / 出一套 xhs 卡片 / 小红书视频 / write a Xiaohongshu note / make a RedNote post。

Writing & Content22

107

Linked-API/linkedin-skills

General-purpose LinkedIn automation – fetch profiles, search people and companies, send messages, manage connections, create posts, and more. Use when the user wants to interact with LinkedIn.

Writing & ContentIn 3 lists19

Browse the most popular Claude skills, all writing & content skills, or write your own with the skills generator.