> For the complete documentation index, see [llms.txt](https://modelmesh.gitbook.io/cline-zhong-wen-ban-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://modelmesh.gitbook.io/cline-zhong-wen-ban-docs/zi-ding-yi-shuo-ming.md).

# 自定义说明

## **为 Teams 构建自定义说明**

**创建标准化的项目说明可确保所有团队成员都遵循一致的准则工作。首先记录项目的技术基础，然后确定说明中需要包含哪些信息。确切的范围会因团队的需求而异，但通常最好提供尽可能多的信息。通过创建所有团队成员都遵循的全面说明，您可以就如何在整个项目中编写、测试和部署代码建立共识，从而产生更易于维护和一致的软件。**

***

以下是团队自定义说明需要考虑的一些主题和示例：

1. **测试框架和特定命令**
   * “所有组件都必须包括覆盖率至少为 85% 的 Jest 测试。在提交任何拉取请求之前，请使用 `npm run test：coverage` 运行测试。
2. **显式库首选项**
   * "“使用 React Query 进行数据获取和状态管理。避免使用 Redux，除非复杂全局状态特别需要。对于样式设置，请使用 Tailwind CSS 和 `src/styles/theme.js` 中的自定义主题配置。
3. **在何处查找文档**
   * “所有 API 文档都可以在我们内部的 Notion 工作区的'工程 > API 参考'下找到。有关组件使用示例，请参阅我们的 Storybook 实例 `https://storybook.internal.company.com` ”
4. **使用哪些 MCP 服务器，以及用于哪些目的**
   * “对于数据库操作，请使用 Postgres MCP 服务器，其凭据存储在'开发 > 数据库'下的 1Password 中。对于部署，请使用 AWS MCP 服务器，该服务器需要 IAM 中的部署角色。有关配置说明，请参阅 `docs/mcp-setup.md`。
5. **特定于您的项目的编码约定**
   * “使用 PascalCase 命名所有 React 组件，使用 camelCase 命名所有辅助函数。将组件放在 `src/components` 目录中，该目录按功能部件（而不是按类型）进行组织。始终使用 TypeScript 接口进行 prop 定义。 


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://modelmesh.gitbook.io/cline-zhong-wen-ban-docs/zi-ding-yi-shuo-ming.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.