帮助文档
整理产品说明、操作步骤与常见问题,让用户从入门到日常使用,都有清楚的指引。
Naisi Docs · 多项目文档管理
把产品使用与开发接入的知识整理在一起。
帮助文档面向日常操作,开发文档服务技术接入,
让每个项目的说明都易于管理、便于查阅。
给每一位产品使用者
给每一位接入开发者
文档组织示意,具体内容按项目提供。
01 / CAPABILITIES
两类文档,各自清晰。
让产品知识与技术说明都有合适的位置。
整理产品说明、操作步骤与常见问题,让用户从入门到日常使用,都有清楚的指引。
集中维护接入说明、接口参数与调用示例,让开发者理解接入方式,核对实现细节。
将各项目的帮助文档与开发文档分别归集,保留独立目录,让不同产品的知识各归其位。
围绕功能变化整理和更新说明,让使用指南与开发参考随项目一起完善。
02 / WORKFLOW
从组织内容到持续更新,
让每一份说明服务实际工作。
确定文档所属项目,区分面向用户与开发者的内容。
围绕使用场景与接入过程,编排目录、说明和示例。
随产品与接口变化更新文档,让查阅内容保持适用。
帮助文档与开发文档请从对应项目的文档入口查阅;具体内容与访问权限以各项目实际提供为准。