Skip to content

Commit

Permalink
docs(book): 添加电子书背景信息和内容概述
Browse files Browse the repository at this point in the history
本书简介和前言部分添加了作者背景、写作动机及电子书内容概述。更新了设计章节中的工具示例,包括GitHub Copilot等市场主流AI辅助软件工具。这些修改旨在为读者提供更全面的背景信息和工具参考,帮助他们更好地理解电子书内容和目的。
  • Loading branch information
phodal committed Aug 1, 2024
1 parent deb7764 commit 62806e8
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 5 deletions.
33 changes: 31 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,42 @@
# 《AI 辅助软件工程:AI IDE 插件与编程智能体示例》(草稿)

2024 年 6 月 1 日,我计划利用在 Thoughtworks 的三个月年资假做一些 AI 辅助研究与超前设计。同时结合之前的
AI 辅助软件工程实践经验以及在 Thoughtworks 的开源项目与落地经验,编写一本关于《AI辅助软件工程》的开源电子书。

- 作为一个新晋奶爸,我需要在带娃的业余时间里完成这本书,所以有些调研会比较仓促和写作进度可能会比较慢。但是,我会尽量保证每周至少更新一篇文章。
- 作为一个工程师,我更喜欢能真正落地的方案,而不是纸上谈兵。所以,我花了大量的时间在收集和分析落地案例,以及在实际项目中的实践经验,以避免浪费读者的时间。

这本开源电子书( https://aise.phodal.com/ )包含了什么:

- 国内外最新的 AI 辅助软件工程实践。我们阅读了大量的国内外生成式 AI 技术博客,收集了从
GitHub、GitLab、Google、JetBrains、Atlassian、New Relic/Dynatrace 等公司的 AI 辅助软件工程实践。
- 从 AI 模型到 IDE 插件的实现细节。作为 IDE 插件 AutoDev 开源项目以及 Shire 编码智能体语言的作者,我会结合实际项目经验,分享如何从
AI 模型到 IDE 插件的实现细节。
- 从编码 RAG 到编码智能体的实践案例与经验。我们收集了大量的编码智能体的实践案例与经验,以及在编码领域如何使用 RAG 模型的实践案例。

这本书没有什么?

- 相关 Paper。作为一个工程师,我更喜欢能真正落地的方案,而不是纸上谈兵。尽管已经有大量的 AI 辅助软件工程的
Paper,从业内的实践经验来看,Paper 与实际落地的差距还是很大的。

如果你对此感兴趣,欢迎加入这个开源项目。

阅读需知:

在大多数组织中,开发者用于编码的时间不到总工作时间的 40%,因此编码提效对整个软件开发生命周期(SDLC)的效能影响很有限,应尝试将
AI 应用于软件 全生命周期和整个团队,而不仅仅是个别成员、个别环节的产出。

## 简介

本书是一本关于如何使用 AI 辅助软件工程的开源电子书。我们将介绍:

- 如何使用生成式 AI 来在软件工程的不同阶段进行辅助。
- AI IDE 编程工具的 Prompt 技巧。
- AI IDE 编程工具的 Prompt 技巧。
- 设计 AI 辅助流程来提高软件工程师的工作效率。
- 定制 AI IDE 来融入不同编程任务。
- 设计和构建 AI 编码智能体。
- 如何使用 Shire 与 RAG 来进行 AI 辅助研发。

开始阅读之前,你需要自行了解一些基本概念:

- 什么是生成式 AI?
Expand All @@ -22,3 +50,4 @@
- 想要了解 AI IDE 插件开发的人。

如果你是以上人群,建议你先了解一些基础知识,然后再来阅读本书。

21 changes: 21 additions & 0 deletions src/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,26 @@
# 前言

2024 年 6 月 1 日,我计划利用在 Thoughtworks 的三个月年资假做一些 AI 辅助研究与超前设计。同时结合之前的
AI 辅助软件工程实践经验以及在 Thoughtworks 的开源项目与落地经验,编写一本关于《AI辅助软件工程》的开源电子书。

- 作为一个新晋奶爸,我需要在带娃的业余时间里完成这本书,所以有些调研会比较仓促和写作进度可能会比较慢。但是,我会尽量保证每周至少更新一篇文章。
- 作为一个工程师,我更喜欢能真正落地的方案,而不是纸上谈兵。所以,我花了大量的时间在收集和分析落地案例,以及在实际项目中的实践经验,以避免浪费读者的时间。

这本开源电子书( https://aise.phodal.com/ )包含了什么:

- 国内外最新的 AI 辅助软件工程实践。我们阅读了大量的国内外生成式 AI 技术博客,收集了从
GitHub、GitLab、Google、JetBrains、Atlassian、New Relic/Dynatrace 等公司的 AI 辅助软件工程实践。
- 从 AI 模型到 IDE 插件的实现细节。作为 IDE 插件 AutoDev 开源项目以及 Shire 编码智能体语言的作者,我会结合实际项目经验,分享如何从
AI 模型到 IDE 插件的实现细节。
- 从编码 RAG 到编码智能体的实践案例与经验。我们收集了大量的编码智能体的实践案例与经验,以及在编码领域如何使用 RAG 模型的实践案例。

这本书没有什么?

- 相关 Paper。作为一个工程师,我更喜欢能真正落地的方案,而不是纸上谈兵。尽管已经有大量的 AI 辅助软件工程的
Paper,从业内的实践经验来看,Paper 与实际落地的差距还是很大的。

如果你对此感兴趣,欢迎加入这个开源项目。

阅读需知:

在大多数组织中,开发者用于编码的时间不到总工作时间的 40%,因此编码提效对整个软件开发生命周期(SDLC)的效能影响很有限,应尝试将
Expand Down
6 changes: 3 additions & 3 deletions src/design-aise.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ Engineering,人工智能用于软件工程)体系是一个复杂且多层次
- Microsoft
- GitHub Copilot ?

工具示例:
市面上的工具示例。

| 环节 | 头部 | 工具 | 特点 | 典型工具 |
|---------|---------------------|----------------------------------------------|-----------------------------------------------------------------------------------|---------------------------------------------------------------|
| 需求/项目管理 | Atlassian | Jira AI Assistant, Atlassian Intelligence | 构建交互式 AI 需求编辑器,提升需求编写效率。扩大生成式 AI 使用触点,提供 AI 跨工具链能力。 | Jira AI Assistant, Atlassian Intelligence |
| 开发与代码协作 | GitHub | GitHub Copilot, Copilot X, Copilot Workspace | 围绕代码开发、协作、构建为核心,以开发者体验作为度量体系; | GitHub Copilot, Copilot X, Copilot Workspace, Dynatrace Davis |
| CI/CD | | GitHub Action, GitLab | | |
| 测试 | ? | Checksum, Testim Copilot | 生成式 AI 测试工具,提供测试用例生成、自动化测试、测试报告等功能。 | Testim |
| CI/CD | GitHub, GitLab | GitHub Action, GitLab | 结合代码平台,构建更符合开发者体验的开发体系 | |
| 测试 | JetBrains | Checksum, Testim Copilot | 生成式 AI 测试工具,提供测试用例生成、自动化测试、测试报告等功能。 | Testim |
| 文档与协作 | Atlassian | Atlassian Rovo | 通过生成式 AI 解锁企业知识的工具,内建和自定义知识管理智能体。 | Atlassian Rovo |
| 基础设施 | AWS/Sysdig | Amazon Q, Sysdig Sag | 在云平台上,关注在 AI 重新定义"安全左迁"。结合生成式 AI 与传统 AI 工具,进行云基础设施排错、问答、网络诊断等。结合云平台,提供对应 AI 辅助能力。 | Amazon Q, Sysdig Sag |
| 可观测性 | New Relic/Dynatrace | NewRelic Grok, Dynatrace Davis | 结合传统判别式 AI 工具,无缝辅助问题定位和修复,与问题回顾。围绕新兴 AI 技术栈构建 AI 应用可观测性。 | NewRelic Grok |
Expand Down

0 comments on commit 62806e8

Please sign in to comment.