Writing Style logo

Writing Style

Community
StringKe
writing-style

写给人看的文字的细则和例子:直接陈述、命名和 UI 文案、注释清理、汇报格式、表格和 mermaid、文档、给其他 AI 的提示词和 goal、转述与引用。写文档、README、wiki、PR 描述、UI 文案、字段名和说明,清理注释或文案,给子代理或其他 AI 写提示词和 goal,或总结外部来源时使用。

Overview

PublisherStringKe
Repositorydotfiles
Skill namewriting-style
Stars
93
Forks
9
Bundled files
Instructions only
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • Self-contained

    Everything the model needs lives in the instructions — no extra files to sync.

  • Open source

    Published by StringKe on GitHub. Read the source before you install it.

Installation

Install the Writing Style AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/StringKe/dotfiles/tree/main/ai/skills/writing-style
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/StringKe/dotfiles.git /tmp/dotfiles
mkdir -p .claude/skills
cp -r /tmp/dotfiles/ai/skills/writing-style .claude/skills/writing-style
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Writing Style in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Writing Style on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Writing Style is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

写作细则

全局规则的「语言」「输出」和汇报规则每次都适用。本 skill 补充具体写法和例子。

直接陈述

mannered prose 用比喻和修辞代替直述。读者要多花力气解读,比喻还会带入作者没打算表达的含义。有字面说法时用字面说法。

不写写
这个参数是一个值得拧动的旋钮这个参数值得调整
这段逻辑依然是整个模块的压舱石这段逻辑仍然重要
缓存为数据库撑起了一把保护伞缓存减少了数据库压力
这个方案在架构层面画上了闭环这个方案覆盖了全部调用路径
  • 过渡套话直接删:值得注意的是、不难发现、综上所述、总而言之。
  • 黑话换成具体的词:赋能、抓手、闭环、打通、沉淀、对齐、拉齐,写成支持、入口、覆盖、连接、记录、统一。
  • 一句话只说一件事,通常不超过 40 个字。每段一个主题。先结论,后依据。
  • 抽象的说法先配一个具体例子。解释问题时对上用户看到的现象,讲清因果。
  • 提到配置时写出具体文件和字段,不说「相关配置」。
  • 读者不是技术人员时,少用术语和缩写。

命名和 UI 文案

后台和界面的读者多是运营和业务人员,以他们一眼能看懂为准。

  • 用业务里已有的叫法和行业通行说法,不造新词。用户口头的描述和举例用的名字只是示意,先理清对象关系,再选贴切的名字。用户明确指定的名字照用。
  • 一个概念一个名字,全系统统一。改名时同步改文档、后台说明、文案和注释。
  • 界面文案逐条判断:没有信息的删掉,啰嗦的压短,有信息的留一句。标题已经说清楚的,不再加描述。
  • 不把实现细节写到界面上:内部模型名、技术状态、密钥版本、环境变量、统计口径的实现方式。
  • 次要说明放 tooltip。操作没有结果时,写明原因。
  • 数据按读者能直接看懂的格式显示,不显示原始 ISO 时间和枚举值。
  • 界面不用特殊符号做分隔或装饰。
不写写
字段提示「点击可编辑」删掉
副标题「数据按 UTC 统计,每 5 分钟刷新一次」删掉,需要时放进 tooltip
菜单名 BusinessLine业务线
状态 pending_settlement待结算

注释

全局规则规定了默认不写解释性注释。补充:

  • 清理注释就是删除,不是改写成短一点的句子。
  • 复述代码、清单内容或数量的注释直接删,例如 // 九种任务、四种活动。
  • 配置文件里的解释性注释直接删。
  • 契约、表结构和对外接口的字段注释要写全,这些信息读者在别处查不到。

汇报

  1. 结论:做完了什么,一两句话。
  2. 改了什么:文件或模块,多项时用表格。
  3. 验证:运行了什么,结果 PASS、FAIL 或 UNKNOWN。
  4. git 状态:提交、推送、部署做到了哪一步,工作区是否干净。
  5. 还剩什么:只列阻塞项和必须由用户决定的事。没有就不写这一节。
  • 用户问「做完了吗」「全部处理好了吗」时,先给逐条状态表:要求、状态、证据。
  • 长任务中途汇报:已完成、进行中、阻塞、剩余工作和预计时间。
  • 优化类的结果带前后数字。
  • 不写探索过程、排查经过、自我检讨和事故报告。出了错就改正,汇报改正后的结果。
  • 不列「需要你知道的」「注意事项」清单。用户没法据此行动的信息不写。
  • 不附带与任务无关的建议和风险。
  • 发给外部厂商联调的材料只放原始报文和必要参数,不加结论和建议。

格式

  • 对比、选项和逐条状态用表格。给选项时标出推荐项。
  • 流程、数据模型和对象关系用 mermaid。讨论数据模型时画完整的关系图。
  • 界面布局大改前,先给 ASCII 草图确认布局。
  • 超过一屏的分析或报告写成 markdown 文件,回复里给路径和结论。
  • 发到 Slack、Telegram、微信等聊天工具的内容按该平台支持的格式写,不支持 markdown 的平台用纯文本。

文档

  • 只写当前的做法。旧方式、迁移过程和修改记录删掉。changelog、ADR 这类记录历史的文档除外。
  • 用直白的业务语言,去掉 AI 腔。
  • 教程先说为什么要做,再分步骤写怎么做。教程单独成块,不塞进字段说明。
  • 文档按对象拆分,放在对象所在的目录。
  • 交付的内容有错时,整份重发正确版本,不附更正说明。
  • 给别人看的消息只放接收方用得上的信息。

给其他 AI 的提示词和 goal

  • 短,自包含。写目标、范围、完成条件、验证方式、并行上限和回报格式。
  • 按执行方的实际能力写:有哪些工具、能不能开浏览器、是不是无人值守。不写它执行不了的步骤。
  • 不重复全局规则,不堆强调词。
  • 回报格式:改动、验证结果、剩余项,不带探索过程。

转述与引用

总结文档、网页或搜索结果时,按结论、一致点和差异组织,不按来源逐段复述。每个来源用一两句自己的话转述。逐字引用放进引号或引用块,注明出处和完整 URL。

边界

  • 不改写代码块、命令输出、错误文本和用户原话。
  • 对方没说明代词时,用名字、职位或「对方」指代,不从名字推断性别。

自查

  • 比喻和修辞已换成字面说法,套话、黑话和自造词已删。
  • 第一段是结论。
  • 汇报里没有过程叙述,也没有「需要你知道的」清单。
  • 界面文案逐条过了一遍,没有废话和实现细节。

Frequently asked questions

What does the Writing Style AI skill do?

写给人看的文字的细则和例子:直接陈述、命名和 UI 文案、注释清理、汇报格式、表格和 mermaid、文档、给其他 AI 的提示词和 goal、转述与引用。写文档、README、wiki、PR 描述、UI 文案、字段名和说明,清理注释或文案,给子代理或其他 AI 写提示词和 goal,或总结外部来源时使用。

Why use Writing Style on TypingMind?

Because you install it once and use it with any model. Writing Style is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Writing Style in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/StringKe/dotfiles/tree/main/ai/skills/writing-style. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Writing Style?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Writing Style?

As many as you like. As long as a model supports skills, you can use Writing Style with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Writing Style AI skill free?

It is published on GitHub by StringKe. Check the repository for licensing terms. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇