技术文档里有些数字是能当场核对的。Mintlify 的写作指南给过两条:句子尽量控制在25个词以内,每段两到四个句子。
这两条不用工具,随便打开一页文档就能数。
指南还建议标题按用户会问的问题来写,比如“如何配置身份验证”,而不是“身份验证配置”。同一个概念全程用一个词,别在 API key 和 API token 之间来回换。
篇幅那块说得比较含糊,只说覆盖完整又保持聚焦,这属于判断,不算硬指标。倒是语气方面的建议很具体:跳过“值得注意的是”“只需”这类填充短语。
下次改文档前先数两个数,词数和段长,比争论风格快。