文件标准

文档 社区

技能解读

当前原文的自动摘译,尚未人工审校。

核心原则

受众至上:为读者而不是自己而写作 保持最新:过时的文档比没有文档更糟糕 显示,不要只是讲述:使用示例和图表 一致的格式:遵循既定模式

硬性要求(写作)

无 AI 溢出 - 删除填充物,保持文档具体且以任务为导向 无长破折号/短破折号 - 使用连字符 (-) 代替

Diataxis 快速指南

每页使用一种主要文档模式: 教程 - 边做边学 操作指南 - 任务完成 参考 - 事实查找 解释 - 概念和基本原理

标头

使用 # 层次结构(不要跳过级别) 保持标题简洁 标题使用标题大小写,保留已建立的首字母缩略词和产品名称

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
文档
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@tomevault-io · 未声明许可证
上下文用量评级
低消耗
接入复杂程度
即装即用
是否需要外部接口密钥
不需要
兼容的系统
macOS · Linux · Windows
运行环境要求
Python
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
网络行为
仅限本地
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

输出预览 documentation-standards.preview
import { thing } from 'my-project';
thing.doSomething();

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。