用途:审查或撰写 Sentry 面向用户的文档,确保符合其风格与语气规范。主要能力:按 Sentry 风格指南检查文档,指出违规之处并给出符合风格的具体改写建议;检查项包括语气是否像开发者之间的交流、是否去除营销套话、段落是否简短易扫读、标题是否用 Title Case 且不连续堆叠、是否使用主动语态、代码示例是否清晰可运行且用现代语法、拼写是否符合美式英语。风格要点:以支持性同行口吻写作,用 we 涵盖作者与读者;直接诚实,避免“业界领先”“协同”之类空话;自信但谦逊;使用中性语言,用 they/them 指代读者;优先短段落(2–3 句)和项目符号列表;标题用 Title Case,且标题之间必须有正文;使用主动语态;技术术语适当大写,如 Single Sign-On、Time-series;用加粗突出关键操作或警告。适用场景:审查或撰写 Sentry 用户文档时使用。限制:资料未提供安装方式、价格、平台或具体调用指令,暂未提供。
docs-review
写作与研究
更新于 10-15 21:51