用途:用于撰写、编辑或审校技术内容,如指南、教程和文档,帮助保持语气、格式与术语的一致性。
主要能力:规定写作语气与视角,优先使用第一人称复数(如“we'll install...”)拉近读者,指令部分使用第二人称祈使句(如“Type npm install.”);要求观点明确而非面面俱到,避免称内容“简单”或“显而易见”,避免以个人背景或定义开头,避免营销话术和百科式内容。格式上要求使用连续逗号、常见缩写、标题用句子大小写;行内代码用反引号,可运行命令用围栏代码块并标注语言;截图前先有文字,连续两张截图之间必须有文字。数字方面,十以下及句首数字拼写,10及以上用阿拉伯数字,超过三位加逗号。品牌名需按官方大小写核对,如 JavaScript、GitHub、Node.js。
使用方式:按需加载参考文件。完整风格指南见 references/styleguide.md;语法与标点、大小写、缩写、数字、代词及词表见 references/grammar.md;品牌名大小写见 references/brand-names.md;截图分辨率、标注、GIF 及图文结合见 references/screenshots.md;发布前审查清单见 references/guide-audit.md。审校已有内容时加载语法与风格指南并核对品牌名;写新教程时加载风格指南,添加视觉内容时参考截图文档;发布前用 guide-audit 清单检查字数、结构与内容质量。
适用场景:技术博客、产品文档、教程、操作指南的写作与审校。
限制:资料未提供具体安装命令、平台支持、收费方式或自动化工具集成信息。