GitHub SOP

1. 目的

2. 范围

3. 职责

4. 定义或术语

5. 内容

6. 相关记录

7. 参考文件

8. 相关附件

commit

### Commit 1 (commit hash)

Summary

commit的摘要

Changes

列出主要的代码更改和功能添加

Learnings

学到的知识点和经验教训

Questions

在阅读和学习过程中遇到的疑问

### Commit 2 (commit hash)

Summary

commit的摘要

Changes

列出主要的代码更改和功能添加

Learnings

学到的知识点和经验教训

Questions

在阅读和学习过程中遇到的疑问

...

GitHub Repo 笔记

{{renderer :toc_rrznswr}}

### Repo 概述

作者: {{作者名字}}

链接: {{Repo 链接}}

项目简介: {{项目简要说明}}

核心技术: {{主要使用的技术或框架}}

### Repo 结构与组织

本地文件夹:

文件夹结构: {{简要描述项目的文件夹结构}}

代码规范: {{代码规范或风格，例如 PEP8、Google Style Guide 等}}

文档: {{描述项目的文档情况，包括注释、README、Wiki 等}}

### 部署方法

环境要求: {{项目所需的操作系统、软件和依赖库}}

虚拟环境:

安装依赖: {{安装依赖库的命令或方法}}

错误解决:

错误1：

解决方案：

配置项目: {{如何配置项目设置，例如修改配置文件}}

构建项目: {{如何构建或编译项目，例如使用 Makefile 或其他工具}}

部署项目: {{如何部署项目到服务器或本地运行，例如使用 Docker 或其他工具}}

测试项目: {{如何进行项目测试，例如使用单元测试或集成测试}}

### Commits追踪

#### Commit 1 (commit hash)

Summary

commit的摘要

Changes

列出主要的代码更改和功能添加

Learnings

学到的知识点和经验教训

Questions

在阅读和学习过程中遇到的疑问

#### Commit 2 (commit hash)

Summary

commit的摘要

Changes

列出主要的代码更改和功能添加

Learnings

学到的知识点和经验教训

Questions

在阅读和学习过程中遇到的疑问

...

### 学习过程

阅读文档: {{熟悉项目的README、Wiki、API文档等，以了解项目的整体结构、功能和使用方法}}

分析代码结构: {{浏览项目的目录结构，识别关键模块和组件}}

跟踪关键函数调用: {{找到代码的入口点（例如 main 函数），然后跟踪关键函数和方法的调用顺序，以了解代码的执行流程}}

Debug: {{使用调试器（例如：pdb、gdb等）逐步执行代码，观察变量的值和函数调用情况，以便更深入地理解代码逻辑}}

编写测试用例: {{为关键功能编写测试用例，通过实践来加深对代码的理解}}

重构与优化: {{尝试对代码进行重构和优化，以提高代码质量和可读性}}

与项目维护者交流: {{在遇到问题或需要澄清的地方时，与项目的维护者或作者进行交流，以获取更多的信息和帮助}}

学习相关资料: {{查阅相关的书籍、博客、论文等资料，以便更好地理解项目中使用的技术和算法}}

### 实践与应用

示例项目: {{基于该 Repo 的示例项目或实际应用}}

可能的改进: {{项目中可以优化或改进的地方}}

扩展思路: {{如何在该项目基础上进行扩展或创新}}

### 学到的知识点与经验

技巧一: {{学到的技巧及其应用场景}}

技巧二: {{学到的技巧及其应用场景}}

经验教训: {{在学习过程中遇到的问题和解决方法}}

总结: {{总结学习收获，以及对其他相关项目的启示}}

prompt

{{renderer :toc_ediznd}}

### 描述

特点

效果

应用场景

优缺点

### 示例

#### 初始版本

Prompt

AI输出

解析

#### 迭代版本

Prompt

AI输出

解析

### 使用技巧

如何优化Prompt

如何获取更好的输出

### 注意事项

避免误导性信息

数据隐私和安全性

基本项目管理

目标

规划

任务

资源

时间

成本

执行

控制

收尾

[[项目文档模板]]

1. 项目概述和范围

1.1 项目背景

1.2 项目目标

1.3 项目范围

1.4 项目变更记录

2. 需求分析

2.1 用户需求

2.2 功能需求

2.3 性能需求

2.4 需求变更记录

3. 系统设计

3.1 概念设计

3.2 系统架构

3.3 系统接口

3.4 数据字典和数据流图/UML图

3.5 系统设计变更记录

4. 方案设计

4.1 方案设计说明

4.2 技术选型

4.3 硬件/软件设计规格

4.4 安全和风险分析

4.5 方案设计变更记录

4.6 算法与工具学习记录

5. 详细设计

5.1 详细设计说明

5.2 硬件设计图纸和说明

5.3 软件源代码和注释

5.3.1 代码组织结构

5.3.1.1 目录结构

5.3.1.1.1 前端目录结构

5.3.1.1.2 后端目录结构

5.3.1.1.3 数据库目录结构

5.3.1.2 模块划分

5.3.1.2.1 前端模块划分

5.3.1.2.2 后端模块划分

5.3.1.2.3 数据库模块划分

5.3.2 关键算法和数据结构

5.3.2.1 算法1

5.3.2.1.1 算法描述

5.3.2.1.2 算法实现

5.3.2.1.3 算法性能分析

5.3.2.2 算法2

5.3.2.2.1 算法描述

5.3.2.2.2 算法实现

5.3.2.2.3 算法性能分析

5.3.2.3 数据结构1

5.3.2.3.1 数据结构描述

5.3.2.3.2 数据结构实现

5.3.2.3.3 数据结构性能分析

5.3.2.4 数据结构2

5.3.2.4.1 数据结构描述

5.3.2.4.2 数据结构实现

5.3.2.4.3 数据结构性能分析

5.3.3 核心功能实现

5.3.3.1 功能1

5.3.3.1.1 代码段示例

5.3.3.1.2 注释和解释

5.3.3.1.3 单元测试和集成测试

5.3.3.2 功能2

5.3.3.2.1 代码段示例

5.3.3.2.2 注释和解释

5.3.3.2.3 单元测试和集成测试

5.3.4 辅助工具和库

5.3.4.1 工具1

5.3.4.1.1 工具描述

5.3.4.1.2 工具使用方法

5.3.4.2 工具2

5.3.4.2.1 工具描述

5.3.4.2.2 工具使用方法

5.3.4.3 库1

5.3.4.3.1 库描述

5.3.4.3.2 库的引入和配置

5.3.4.3.3 库的主要功能和使用示例

5.3.4.4 库2

5.3.4.4.1 库描述

5.3.4.4.2 库的引入和配置

5.3.4.4.3 库的主要功能和使用示例

5.3.5 代码规范和风格

5.3.5.1 编码规范

5.3.5.1.1 命名规范

5.3.5.1.2 缩进和空格

5.3.5.1.3 代码结构和布局

5.3.5.2 注释规范

5.3.5.2.1 注释风格

5.3.5.2.2 注释内容要求

5.3.5.3 代码审查和质量保证

5.3.5.3.1 代码审查流程

5.3.5.3.2 代码审查工具和方法

5.3.5.3.3 代码质量指标和监控

5.4 数据库设计

5.5 用户界面设计

5.6 详细设计变更记录

6. 测试

6.1 测试计划

6.2 测试用例/脚本

6.3 测试数据

6.4 测试结果和故障报告

6.5 测试与部署变更记录

7. 整改和优化

7.1 变更请求和评审记录

7.2 已实施变更的详细记录

8. 工艺实现和部署

8.1 生产/部署流程

8.2 制造/部署指导书

8.3 质量检验标准和方法

8.4 供应商和物料清单（如适用）

9. 用户文档

9.1 用户手册

9.2 操作和维护手册

9.3 培训资料

9.4 常见问题解答（FAQ）

10. 项目总结和经验教训

10.1 项目总结报告

10.2 经验教训总结

[[项目文档模板]]精简版

项目概述和范围

项目背景

项目目标

项目范围

需求分析

用户需求

功能需求

性能需求

设计与实现

系统架构

核心功能实现

功能1

代码段示例

注释和解释

功能2

代码段示例

注释和解释

数据库设计

用户界面设计

代码规范与风格

编码规范

命名规范

缩进和空格

代码结构和布局

注释规范

注释风格

注释内容要求

测试与部署

测试计划

测试用例/脚本

测试数据

测试结果和故障报告

部署流程

项目总结和经验教训

项目总结报告

经验教训总结

GitHub Repo 笔记

Repo 概述

作者: {{作者名字}}

链接: {{Repo 链接}}

项目简介: {{项目简要说明}}

核心技术: {{主要使用的技术或框架}}

Repo 结构与组织

文件夹结构: {{简要描述项目的文件夹结构}}

代码规范: {{代码规范或风格，例如 PEP8、Google Style Guide 等}}

文档: {{描述项目的文档情况，包括注释、README、Wiki 等}}

部署方法

环境要求: {{项目所需的操作系统、软件和依赖库}}

安装依赖: {{安装依赖库的命令或方法}}

配置项目: {{如何配置项目设置，例如修改配置文件}}

构建项目: {{如何构建或编译项目，例如使用 Makefile 或其他工具}}

部署项目: {{如何部署项目到服务器或本地运行，例如使用 Docker 或其他工具}}

测试项目: {{如何进行项目测试，例如使用单元测试或集成测试}}

学习过程

阅读文档: {{熟悉项目的README、Wiki、API文档等，以了解项目的整体结构、功能和使用方法}}

分析代码结构: {{浏览项目的目录结构，识别关键模块和组件}}

跟踪关键函数调用: {{找到代码的入口点（例如 main 函数），然后跟踪关键函数和方法的调用顺序，以了解代码的执行流程}}

Debug: {{使用调试器（例如：pdb、gdb等）逐步执行代码，观察变量的值和函数调用情况，以便更深入地理解代码逻辑}}

编写测试用例: {{为关键功能编写测试用例，通过实践来加深对代码的理解}}

重构与优化: {{尝试对代码进行重构和优化，以提高代码质量和可读性}}

与项目维护者交流: {{在遇到问题或需要澄清的地方时，与项目的维护者或作者进行交流，以获取更多的信息和帮助}}

学习相关资料: {{查阅相关的书籍、博客、论文等资料，以便更好地理解项目中使用的技术和算法}}

实践与应用

示例项目: {{基于该 Repo 的示例项目或实际应用}}

可能的改进: {{项目中可以优化或改进的地方}}

扩展思路: {{如何在该项目基础上进行扩展或创新}}

学到的知识点与经验

技巧一: {{学到的技巧及其应用场景}}

技巧二: {{学到的技巧及其应用场景}}

经验教训: {{在学习过程中遇到的问题和解决方法}}

总结: {{总结学习收获，以及对其他相关项目的启示}}

笔记最佳实践

1. 分层次地组织内容：从大主题到小主题，逐步细化。在目录层级中，尽量保持层次结构清晰，避免过深的嵌套。

2. 创建文章页面：在适当的层级创建文章页面。对于有足够内容和需要单独讨论的主题，将其设为单独的页面（加双括号[[]]）。具体的层级取决于你的需求和内容的复杂程度。通常，二级或三级目录开始创建文章页面是比较合适的。但要根据实际情况灵活调整。

3. 以迭代方式拆分与整理：在开始撰写笔记时，可能无法完全预见内容的拆分方式。因此，允许自己进行迭代式地拆分与整理。随着对主题的深入了解，逐步对目录进行细化，将其拆分为更具体的子主题，并创建相应的文章页面。

4. 保持笔记的连贯性和一致性：在整理和拆分笔记时，确保每个页面和目录之间的关联和一致性。这有助于更好地理解和回顾笔记内容。

5. 定期回顾和更新：对笔记进行定期回顾和更新，以确保信息的准确性和完整性。在回顾过程中，可以对目录进行进一步拆分，对文章进行总结归纳和续写。

6. 使用标签和链接：为笔记添加标签，以便于搜索和分类。在相关页面之间建立链接，有助于建立知识体系并提高检索效率。