Refine README for clarity and structure
- Improved wording in "Why DevChat?" section. - Added "Context Building" section. - Simplified information about Git or SVN requirement. - Relocated "What is PCSD?" section. - Removed "Automated Publishing Process" section.
This commit is contained in:
Jinglei Ren
parent
5da04b510e
commit
c23a71e67a
80
README.md
80
README.md
@ -22,26 +22,34 @@
|
||||
|
||||
## What is DevChat?
|
||||
|
||||
DevChat is an open-source platform that empowers developers to leverage AI for code generation and documentation. We aim to go beyond simple code auto-completion and limited operations on brief code snippets. DevChat offers a highly *practical* and *effective* way for developers to interact and collaborate with large language models (LLMs).
|
||||
DevChat is an open-source platform that empowers developers to leverage AI for code generation and documentation. We aim to go beyond simple code auto-completion and limited operations on code snippets. DevChat offers a highly *practical* and *effective* way for developers to interact and collaborate with large language models (LLMs).
|
||||
|
||||
## Why DevChat?
|
||||
|
||||
While there are many AI coding tools available, we created DevChat based on our unique insights gained from generating tens of thousands of lines of code. If you agree with our perspectives outlined below, DevChat could be the perfect choice for you.
|
||||
|
||||
- **The value of prompt "engineering" is often overestimated**. While a well-crafted prompt template can be helpful, it's not worth spending more than an hour or two to create a few effective ones and share them with your team.
|
||||
- **The value of "prompt engineering" is often overstated**. While a well-crafted prompt template can be beneficial, it doesn't justify spending days or weeks of study. Instead, dedicate an hour or two to create a few effective templates and share them with your team.
|
||||
- The art of writing prompts is a skill honed through practice. It's not about templates or engineering, but about **refining individual prompts for specific tasks on a case-by-case basis**.
|
||||
- **The bottleneck in harnessing AI's capabilities lies in how to embed the right context in a prompt**. This isn't merely about the token limit of an AI model's input. Even with an infinite number of tokens, existing AI models would struggle to yield satisfactory results without a proper separation of concerns.
|
||||
- **Use AI only when it truly adds value**. Our misconception about AI's capabilities is even a greater issue than hallucination of LLMs. What we need is a tool that boosts productivity, not merely an experimental tool.
|
||||
|
||||
In alignment with our perspectives, DevChat incorporates the following design choices:
|
||||
- **A simple, extensible prompt directory**. This allows developers or teams to easily integrate their own predefined prompt snippets into DevChat, avoiding significant engineering effort or a steep learning curve. You don't need [LangChain](https://github.com/langchain-ai/langchain) to make AI work for you.
|
||||
- **Precise, manual control over the context embedded in a prompt**. This isn't a feature to be overlooked in the quest for greater intelligence or autonomy. Just as manual driving remains a reliable choice until autonomous driving fully matures, manual control over context is crucial for effective AI use. In our view, [Sourcegraph Cody](https://marketplace.visualstudio.com/items?itemName=sourcegraph.cody-ai) tends to over-guess what a user needs to put into the context of a prompt, which exceeds the actual intelligence of the Claude model it employs.
|
||||
|
||||
## Explore Our Features
|
||||
|
||||
- Great output requires great input, to maximize the power of AI, DevChat assists you seamlessly to **provide the right context** to the AI.
|
||||
|
||||
Chat history, code, files, directory trees, `git diff --cached`, or the output of any command.
|
||||
In alignment with our perspectives, DevChat incorporates the following design choices:
|
||||
- **A simple, extensible prompt directory**. This allows developers or teams to easily integrate their own predefined prompt snippets into DevChat, avoiding significant engineering effort or a steep learning curve. You don't need [LangChain](https://github.com/langchain-ai/langchain) to make AI work for you.
|
||||
- **Precise control over the context embedded in a prompt**. This isn't a feature to be overlooked in the quest for greater intelligence or autonomy. Precise control over context is crucial for effective AI use. In our view, [Sourcegraph Cody](https://marketplace.visualstudio.com/items?itemName=sourcegraph.cody-ai) tends to over-guess what a user needs to put into the context of a prompt. This typically introduces more noise than the Claude model it utilizes can effectively manage.
|
||||
|
||||
### Context Building
|
||||
|
||||
Great output requires great input, to maximize the power of AI, DevChat assists you seamlessly to **provide the right context** to the AI.
|
||||
|
||||
- The most fundamental operation involves selecting code (either files or snippets) and adding it to DevChat. For instance, you can add a function along with an existing test file to the prompt context, and ask DevChat to generate several test cases for the function. The test file serves as a useful reference for DevChat, enabling it to understand how to write a valid test case in your environment, thus eliminating the need for you to specify every requirement or setup in your prompt.
|
||||
|
||||
- You can incorporate the output of any command, such as `tree ./src`, into a prompt with DevChat. For example, you can add the output of `git diff --cached` to DevChat, which can then generate a commit message for you.
|
||||
|
||||
- Program analysis can assist in building the necessary context. Suppose you want DevChat to explain some code to you. DevChat can perform better if it's aware of the dependent functions that the code calls. In this scenario, you select the target code to explain and add "symbol definitions" to the context. DevChat will then generate a prompt that explains the target code, taking into account the dependent functions.
|
||||
|
||||
### Prompt Extension
|
||||
|
||||
|
||||
|
||||
@ -53,12 +61,30 @@ Once you have generated code with AI, DevChat **streamlines the actions** to pro
|
||||
|
||||
|
||||
|
||||
- To guide AI in your work, define **your own workflows** with DevChat.
|
||||
|
||||
|
||||
***
|
||||
|
||||
Explore more prompt templates, iterative calls to AI, and program operations.
|
||||
## Quick Start
|
||||
|
||||
> Chinese: [中文安装配置指南](https://zh.devchat.blog/devchat-vscode-installation-guide).
|
||||
|
||||
- Install [Visual Studio Code](https://code.visualstudio.com/download).
|
||||
- Open the Extensions view (⇧⌘X), search for DevChat, and install the extension:
|
||||
|
||||
<img width="220" alt="image" src="https://github.com/devchat-ai/devchat-vscode/assets/592493/c30f76fe-321a-4145-88fa-a0ef3d36bde5">
|
||||
|
||||
- Be sure to open a Git or SVN project.
|
||||
- Set your [OpenAI API Key](https://platform.openai.com/account/api-keys) by running `export OPENAI_API_KEY="[sk-...]"` (or set it to your DevChat access key instead).
|
||||
- Click on the DevChat icon in the status bar. If the API key setting is not configured, it will prompt you to enter it. Simply input the key.
|
||||
|
||||
<img width="400" alt="image" src="https://github.com/devchat-ai/devchat-vscode/assets/592493/56f261c0-3aae-4df6-b699-c9e757bd91c1">
|
||||
|
||||
- We recommend dragging the DevChat logo from the left sidebar to **the right sidebar** to avoid overlapping with the Explorer.
|
||||
|
||||
## Community
|
||||
|
||||
- Join our [Discord](https://discord.gg/9t3yrbBUXD)!
|
||||
- Participate in [discussions](https://github.com/devchat-ai/devchat/discussions)!
|
||||
|
||||
## What is Prompt-Centric Software Development (PCSD)?
|
||||
|
||||
- The traditional code-centric paradigm is evolving.
|
||||
@ -75,40 +101,12 @@ Once you have generated code with AI, DevChat **streamlines the actions** to pro
|
||||
|
||||
<sub>(This image is licensed by devchat.ai under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.)</sub>
|
||||
|
||||
***
|
||||
|
||||
## Quick Start
|
||||
|
||||
> Chinese: [中文安装配置指南](https://zh.devchat.blog/devchat-vscode-installation-guide).
|
||||
|
||||
- Install [Visual Studio Code](https://code.visualstudio.com/download).
|
||||
- Open the Extensions view (⇧⌘X), search for DevChat, and install the extension:
|
||||
|
||||
<img width="220" alt="image" src="https://github.com/devchat-ai/devchat-vscode/assets/592493/c30f76fe-321a-4145-88fa-a0ef3d36bde5">
|
||||
|
||||
- Since DevChat is designed for developers, it requires a Git or SVN repository folder to store metadata. Therefore, be sure to open a Git or SVN project.
|
||||
- Set your [OpenAI API Key](https://platform.openai.com/account/api-keys) by running `export OPENAI_API_KEY="[sk-...]"` (or set it to your DevChat access key instead).
|
||||
- Click on the DevChat icon in the status bar. If the API key setting is not configured, it will prompt you to enter it. Simply input the key.
|
||||
|
||||
<img width="400" alt="image" src="https://github.com/devchat-ai/devchat-vscode/assets/592493/56f261c0-3aae-4df6-b699-c9e757bd91c1">
|
||||
|
||||
- We recommend dragging the DevChat logo from the left sidebar to **the right sidebar** to avoid overlapping with the Explorer.
|
||||
|
||||
## Community
|
||||
|
||||
- Join our [Discord](https://discord.gg/9t3yrbBUXD)!
|
||||
- Participate in [discussions](https://github.com/devchat-ai/devchat/discussions)!
|
||||
|
||||
## Contributing
|
||||
|
||||
Issues and pull request are welcome:
|
||||
- https://github.com/devchat-ai/devchat/issues
|
||||
- https://github.com/devchat-ai/devchat-vscode/pulls
|
||||
|
||||
## Automated Publishing Process
|
||||
|
||||
Check out our [Automated Publishing Process](./docs/publish.md) for a detailed walkthrough of how we manage the automated release of new versions for the DevChat VSCode Extension.
|
||||
|
||||
## Contact Information
|
||||
|
||||
hello@devchat.ai
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user