教程发布规范：让别人能够复现你的经验

[apuos-admin]

一篇教程需要包含什么

建议按“目标、设备与版本、前置条件、步骤、验证、回退”组织内容。先解释要完成什么，再说明实际验证过的环境和需要的权限。命令、配置文件和截图应配合文字说明，读者需要知道每一步改变了什么，以及如何判断它是否成功。

区分验证结果和推测

只把自己确实验证过的设备、版本和功能写成已经可用。未测试的系统、浏览器或原生移动平台请明确注明。分享容器和工作流时提供软件版本与公开来源，说明数据目录、端口和调用服务；不要求读者直接复制自己的密码、私钥或有效令牌。

关注可回退性

对文件、存储或网络配置有影响的步骤，先讲清备份与恢复方式。测试完成后说明如何删除仅属于测试的资源，避免读者误清理业务文件。引用他人项目或文章时注明来源与许可证，使用个人样例代替敏感业务内容。

发布后可在原主题持续更新适用版本，其他用户复现时说明自己的环境与结果。发现平台缺陷时创建独立Bug主题并双向链接。浏览全部应用可以找到更多可分享的实际场景。

发布前检查

请先搜索已有主题，一帖讨论一个主要问题。截图和日志请遮蔽密码、访问令牌、配对码、许可证私钥、个人文件和设备序列号。社区账号独立于 NAS 账号。涉及存储操作时先备份重要数据，按照实际设备与版本核对说明。