使用文档项目文档

项目文档

按目录管理项目文档,查看历史版本,并通过知识助手检索内容。

建立清晰的目录

在项目文档中按主题组织目录,例如产品方案、技术设计、交付记录和使用手册。优先按读者要回答的问题命名,而不是仅以日期命名。

文档支持目录、版本历史、权限设置和回滚。方案中可以记录背景、决策和执行结果,供项目成员查阅。

Feronavi 项目文档Feronavi 项目文档

编写文档

  • 开头说明读者、适用范围和前置条件。
  • 为每个独立话题使用明确的小标题。
  • 命令注明运行位置,示例地址和令牌注明需要替换。
  • 方案说明原因和取舍,交付记录说明结果与验证方式。
  • 修改过时内容时核对相关工作项,避免资料与实际状态脱节。

版本与访问

在版本历史中查看修改内容,必要时恢复到旧版本。文档访问遵循项目和文档的可见范围;分享一个链接并不会自动授予读取权限。

涉及凭据的内容应通过专用配置入口管理,不要在文档正文或聊天问题里保存真实令牌。

在知识助手中检索

知识助手可以检索当前账号有权访问的项目文档,并在回答中附来源。使用明确的标题,并在正文中写全问题背景,方便查找和检索。

如果答案缺少依据,先回到原始文档核对;如果文档刚更新,检查知识检索与模型配置状态。详细说明见知识助手。

输入关键词,搜索全部使用文档。