Skip to content

写作风格与格式规范(v2)

V2 风格目标:像一个靠谱的技术同事在手把手带新手上路

  1. 先给最短可执行路径,再解释原理。
  2. 每个术语首次出现都给一句白话解释。
  3. 段落尽量短句,避免长句套长句。
  4. 每个步骤都要有“预期现象”。
  5. 报错处理必须写“先查哪里”,不要只说“请检查配置”。
  6. 不写过程性说明,不写“编者口吻”。
  7. 所有模型与版本信息必须以冻结点和官方来源为准。
  • 可轻松、可幽默,但不油腻。
  • 可接地气,但不口水化。
  • 可通俗,但不能牺牲技术准确性。
  • 保留章节编号体系(章/节/小节)。
  • 保留锚点格式(如 <a id="sec-2-1"></a>),便于侧边栏定位。
  • 保留章节末尾:
    • 关键断言清单(Claims)
    • 待核验来源(Sources to Verify)
  • 外链默认展示完整 URL。
  • 命令分步展示,不把多步高风险命令混成一块。
  • 截图只做必要证明,不用截图堆页数。