跳到主要内容

Local Docs

简介

Local Docs 是 CodeSouler 提供的一个本地文档管理功能，允许用户在项目本地创建和管理设计文档。通过这个功能，您可以更好地组织和追踪项目相关的设计决策和需求文档。

1. 创建 Local Docs​

创建步骤 请按照以下步骤创建 Local Docs：

  1. 在您的项目根目录下创建 .codesouler/docs 文件夹（如果尚未创建）。 [

  2. 在该文件夹中创建 issue_name.md` 文件，例如: IDE插件开发设计文档。用于管理需求设计文档。

  3. 使用 Markdown 格式编写您的文档内容，支持标题、列表、代码块等标准 Markdown 语法。

  4. 您可以根据需要创建多个文档，建议使用有意义的文件名来组织不同的文档。

img

2. 使用 Local Docs​

使用步骤 请按照以下步骤使用 Local Docs：

  1. 在 CodeSouler 对话框中输入 +LocalDocs 命令。

  2. 系统会显示当前项目中所有可用的本地文档列表。

  3. 从列表中选择您需要关联的文档。

  4. 选中的文档将被添加到对话上下文中，您可以基于文档内容进行问答。

  5. 您可以在对话过程中随时切换或添加其他文档。 :::

img

3. 最佳实践​

建议 为了更有效地使用 Local Docs，我们建议：

  1. 保持文档结构清晰，使用适当的标题层级。

  2. 定期更新文档内容，确保信息及时准确。

  3. 为不同的功能模块创建独立的文档。

  4. 在文档中包含必要的上下文信息，便于后续参考。

  5. 使用 Markdown 的代码块功能来展示代码示例。