本项目只是一份面向中文技术文档、产品文案与界面文案的写作 Skill。

飞双江

Chinese Tech Doc Style

地址： github.com/Fenng/tech-doc-style-chinese
本项目只是一份面向中文技术文档、产品文案与界面文案的写作 Skill。

这份 Skill 的目标很明确：中文技术写作应更克制、更准确、更易读。不追求宣传感，也不试图把所有内容都写成统一模板，而是聚焦几类高频问题：
----中文技术文案容易空泛、重复、宣传化
----中文与英文、数字混合排版时可读性差
----常见英文状态词和错误词容易被机械直译
----文档首页、解决方案页、接口说明页、FAQ 的信息密度和结构经常失衡

如果需要一套适合中文技术文档的基础写作规范，这份 Skill 可以直接拿来使用，或是作为参考。

本 Skill 适合以下内容：
    文档首页、落地页、首屏文案
    接口文档、参数说明、错误码说明、更新日志
    产品能力介绍、解决方案页、能力说明页
    界面文案、按钮文案、导航标签、提示信息

不适合以下内容：
    代码字面量
    JSON 键名
    URL
    API 路径
    数据库字段名
    其他机器可读标识符
#How I AI#