用途:面向 Railway 文档库的技术写作规范,指导撰写、编辑、审校和改进文档。适用于 content/docs/ 产品文档、content/guides/ 指南、故障排查页以及 API 参考页;frontmatter 格式、仓库结构与 PR 流程以 CONTRIBUTING.md 为准。
主要能力:统一语气与术语(用 you 称呼读者、以 Railway 指代产品、现在时与主动语态、must 表必需、can 表可选);禁用 please、simply、just 等词及拉丁缩写;反 AI 腔规则(不用长破折号、不过度加粗、不写填充过渡、不加感叹号);规定包容性用词;规定各类内容结构与组件用法(Image、Banner、Collapse、Deploy 按钮、CodeBlock/CodeTab、GraphQLCodeTabs);规定标题、代码块、链接、表格、标点、数字与 UI 交互动词写法。
使用方式:按四阶段流程执行。调查阶段读现有页面、相关页面、CONTRIBUTING.md,检索代码库核实功能,确定内容类型,检查 src/data/sidebar.ts。起草阶段先给结论,一段一意,步骤用祈使动词起头,可选步骤标注 Optional。编辑阶段朗读检查、删冗余、套用规范。验证阶段核对技术准确性、内部链接、代码示例语法与 frontmatter,新产品文档页需确认侧边栏条目,重命名或移动页面需加重定向,无法核实时留注释标注而非猜测。
限制:该技能绑定 Railway 文档仓库的目录结构、组件与侧边栏机制,不适用于其他项目;所有组件语法为仓库自定义,非标准 Markdown。资料未提供具体安装命令、授权方式与收费信息。