Help us learn about your current experience with the documentation. Take the survey.
提示示例页面类型
提示示例提供了使用 GitLab Duo 完成特定开发或业务任务的分步说明。
提示示例应回答以下问题：
- 这个示例解决了什么开发挑战？
- 如何使用 GitLab Duo 解决它？
这些页面应简洁明了且易于浏览。它们不替代网站上的其他文档类型，而是作为补充。页面不应包含大量链接或相关的概念性或任务信息。
格式
提示示例应采用以下格式：
title: 标题（主动词 + 对象，如 "重构遗留代码"）
---
使用此方法的一句话描述。
- 时间估算：X-Y 分钟
- 难度级别：初级/中级/高级
- 先决条件：用户开始前需要具备的条件
（要填写这些项目，请参阅本示例后面的指导。）
## 挑战
1-2 句话描述此示例解决的具体问题。
## 方法
简要描述整体策略以及要使用的 GitLab Duo 工具（通常是 2-4 个关键短语）。
### 步骤 1：[主动词]
[指定要使用的 GitLab Duo 工具] 本步骤完成内容的简要描述。
```plaintext
包含 [方括号] 中占位符的提示模板
```
预期结果：使用此提示时应发生什么。
### 步骤 2：[主动词]
[指定要使用的 GitLab Duo 工具] 本步骤完成内容的简要描述。
```plaintext
下一个包含 [方括号] 中占位符的提示模板
```
预期结果：使用此提示时应发生什么。
## 提示
- 改善结果的可行具体建议
- 需要避免的常见陷阱
- 如果首次尝试不成功，如何迭代
## 验证
确保：
- 质量检查 1 - 具体且可衡量
- 质量检查 2 - 具体且可衡量
- 质量检查 3 - 具体且可衡量提示示例主题标题
标题文本应使用 主动词 + 名词 的结构。
例如：
重构遗留代码调试失败的测试生成 API 文档
避免使用的标题
避免使用以下主题标题：
如何 [做某事]。相反，应使用主动词结构。使用 GitLab Duo 进行 [任务]。相反，应专注于任务本身。技巧和窍门。相反，应将建议融入具体示例中。- 泛泛的标题，如
代码生成，当您想表达具体内容时，应使用类似生成 REST API 端点的标题。
难度级别指南
使用以下指南分配难度级别：
- 初级：复制粘贴提示，几乎不需要自定义。用户按确切步骤操作。
- 中级：需要调整的模板提示。用户需要理解上下文并修改占位符。
- 高级：需要提示迭代和优化的复杂多步工作流。用户创建自定义方法。
先决条件格式
明确说明需要哪些 GitLab Duo 工具。常见的先决条件包括：
- 在 IDE 中打开代码文件，GitLab Duo Chat 可用
- 开发环境已设置，项目需求已定义
- 包含 [特定技术或框架] 的现有代码库
- 至少拥有项目的 Developer 角色
- GitLab Duo 代码建议已启用（如果使用自动补全功能）
时间估算
根据复杂性提供现实的时间范围：
- 简单任务：5-15 分钟
- 中等任务：15-30 分钟
- 复杂任务：30-60 分钟
- 多会话工作：1-2 小时（跨会话进行）
预期结果格式
预期结果应具体且可衡量。例如：
-
应做：
详细分析，识别 3-5 个具体的改进领域，包含代码示例 -
不应做：
代码分析 -
应做：
完整重构的类，改进了方法名称并添加了测试 -
不应做：
更好的代码
提示模板指南
占位符格式
始终使用 [描述性名称] 格式作为占位符。使占位符具体化：
- 应做：
[ClassName]或[file_path]或[specific_framework] - 不应做：
[name]或[thing]或[item]
模板结构
提示应包含以下结构：
- 明确指令：您希望 GitLab Duo 执行的操作
- 具体上下文：要关注或引用的内容
- 预期格式：如何构建响应
- 成功标准：良好输出的外观
提示指南
提示应提供：
- 实用建议：改善结果的技巧
- 常见陷阱：基于用户经验需要避免的错误
- 迭代策略：如何优化最初不工作的提示
- 上下文提示：如何向 GitLab Duo 提供更好的信息
- 工具组合提示：如何有效同时使用 Chat 和代码建议
避免泛泛的建议。对于此特定用例，明确说明什么有效。
验证清单
创建 3-5 个具体、可衡量的检查项，用户可以执行这些检查来验证成功。重点关注：
- 质量指标：输出是否符合标准？
- 功能检查：解决方案是否按预期工作？
- 完整性验证：是否满足所有要求？
- 集成验证：是否与现有代码/系统协同工作？
示例
修改前
以下主题试图在一个示例中涵盖太多不同的场景。不清楚何时使用每种方法，而且提示过于泛泛。
title: 使用 GitLab Duo 进行开发任务
---
您可以使用 GitLab Duo 帮助编码。以下是几种方式：
- 生成代码
- 修复错误
- 编写测试
- 重构代码
请 GitLab Duo 帮助您完成任务。修改后
当信息被拆分为专注的提示示例时，会更加清晰：
title: 重构遗留代码
---
当您需要提高现有代码的性能、可读性或可维护性时，请遵循这些指南。
- 时间估算：15-30 分钟
- 难度级别：中级
- 先决条件：在 IDE 中打开代码文件，GitLab Duo Chat 可用
## 挑战
将复杂、难以维护的代码转换为清晰、可测试的组件，同时不破坏功能。
## 方法
使用 GitLab Duo Chat 和代码建议进行分析、规划和实施。
### 步骤 1：分析
使用 GitLab Duo Chat 了解当前状态。选择要重构的代码，然后询问：
```plaintext
分析 [file_path] 中的 [ClassName]。重点关注：
1. 当前方法及其复杂性
2. 性能瓶颈
3. 可读性可以改进的领域
4. 可以应用的设计模式
提供代码中的具体示例，并建议适用的重构模式。
```
预期结果：包含具体改进建议的详细分析。
## 提示
- 在跳转到实施之前先进行分析。
- 请求 Chat 分析时选择特定的代码部分。
- 请求 Chat 提供您实际代码中的具体示例。
- 引用现有代码库模式以保持一致性。
- 在实施 Chat 的建议时，让代码建议帮助处理语法。
## 验证
确保：
- 生成的代码遵循您团队的风格指南。
- 新结构确实改善了识别出的问题。
- 测试覆盖了重构的功能。