Documentation
README
Peri 博客写作风格指南
基于 docs/blogs/ 下已有文章提炼,覆盖项目介绍、技术复盘、架构讨论、性能优化、架构设计等类型。
核心原则
用工程师的精确度写,直接说事,不绕弯子,但要让没接触过这个领域的读者也能读下去。
每篇文章都要有一个可以一句话说清的核心论点。写之前先问自己——这篇文章想让读者记住什么?如果说不清楚,先别动笔。
工程准确和通俗易懂不矛盾。准确指的是机制不能写错、判断要有依据,不是把术语和代码堆满。读者的下限按「听过这个方向、但没碰过具体实现」来设定——术语第一次出现要带一句白话讲明白是什么,代码块能少则少。宁可多用一句白话解释,也不要让读者卡在某个词上往回翻。
与 Anthropic/Codex 博客的关系: Peri 博客借鉴了 Codex 官方博客的教学式渐进结构(先讲概念定义,再讲为什么重要,最后讲怎么做)、关键术语 bold 强调、以及丰富的交叉引用习惯。但有三个刻意的差异——(1) Peri 的段落更短(2-4 句 vs 3-5 句),保持工程师的切分感;(2) Peri 的语气更直接,可以下判断、可以表现偏好,不完全追求 Codex 的临床式冷静距离感;(3) Peri 不回避第一人称(我们、我),用个人经历和具体场景驱动叙述。
写作流程
按以下六步推进,前五步每步获得用户确认后再进入下一步,第 5 步写完后接第 6 步独立审查。
第 1 步:用户提出方向,AI 用 grill 质询对齐核心命题。 用户描述想写什么——一个功能的设计理念、一个踩坑复盘、一次性能调优经历。AI 在这个阶段只问澄清性问题,不提方案。
This is the opening of the README. Read the full README on GitHub.