以问题和结果为起点
内容从实际问题出发,不只介绍产品功能和参数。说明任务、条件、过程、结果以及限制,让读者能够判断内容是否适合自己。
区分不同层次的信息
事实应能对应可靠来源;经验应交代发生的条件;推测应说明不确定性;个人判断不冒充普遍结论。没有亲自使用或测试的内容,不写成亲历体验。
对操作承担表达责任
涉及部署、数据、权限或费用时,尽量写明前提、风险、验证与恢复方式。不能把未验证的命令描述为适用于所有环境。
记录时间与变化
对容易变化的产品和技术,尽量说明版本、测试日期或资料时点。发现重要变化或错误后,应更新相关说明,并区分文字修订与重新测试。
说明来源与关系
引用资料注明来源,涉及他人作品关注授权与署名。涉及赞助、赠品、推广链接或其他可能影响判断的关系,在具体内容中如实说明。
欢迎有依据的纠正
欢迎指出事实错误、操作遗漏和表达不清。反馈时提供文章地址、具体位置和必要环境,但不要公开账号凭据或其他敏感信息。