Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Japanese README #31

Merged
merged 3 commits into from
Aug 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
<p align="center">
<a href="docs/README_CN.md"><img src="docs/files/%E6%96%87%E6%A1%A3-%E4%B8%AD%E6%96%87%E7%89%88-blue.svg" alt="CN doc"></a>
<a href="README.md"><img src="docs/files/document-English-blue.svg" alt="EN doc"></a>
<a href="docs/README_JA.md"><img src="docs/files/ドキュメント-日本語-blue.svg" alt="JA doc"></a>
<a href="http://www.kuafuai.net"><img src="docs/files/%E5%AE%98%E7%BD%91-%E4%BC%81%E4%B8%9A%E7%89%88-purple.svg" alt="EN doc"></a>
<a href="docs/CONTACT.md"><img src="docs/files/WeChat-%E5%BE%AE%E4%BF%A1-green.svg" alt="roadmap"></a>
</p>
Expand Down
5 changes: 3 additions & 2 deletions docs/README_CN.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# DevOpsGPT: AI驱动的智能软件开发平台

<p align="center">
<a href="docs/README_CN.md"><img src="files/%E6%96%87%E6%A1%A3-%E4%B8%AD%E6%96%87%E7%89%88-blue.svg" alt="CN doc"></a>
<a href="README.md"><img src="files/document-English-blue.svg" alt="EN doc"></a>
<a href="./README_CN.md"><img src="files/%E6%96%87%E6%A1%A3-%E4%B8%AD%E6%96%87%E7%89%88-blue.svg" alt="CN doc"></a>
<a href="../README.md"><img src="files/document-English-blue.svg" alt="EN doc"></a>
<a href="./README_JA.md"><img src="files/ドキュメント-日本語-blue.svg" alt="JA doc"></a>
<a href="http://www.kuafuai.net"><img src="files/%E5%AE%98%E7%BD%91-%E4%BC%81%E4%B8%9A%E7%89%88-purple.svg" alt="EN doc"></a>
<a href="CONTACT.md"><img src="files/WeChat-%E5%BE%AE%E4%BF%A1-green.svg" alt="roadmap"></a>
</p>
Expand Down
88 changes: 88 additions & 0 deletions docs/README_JA.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# DevOpsGPT: AI 主導のソフトウェア開発自動化ソリューション

<p align="center">
<a href="./README_CN.md"><img src="files/%E6%96%87%E6%A1%A3-%E4%B8%AD%E6%96%87%E7%89%88-blue.svg" alt="CN doc"></a>
<a href="../README.md"><img src="files/document-English-blue.svg" alt="EN doc"></a>
<a href="./README_JA.md"><img src="files/ドキュメント-日本語-blue.svg" alt="JA doc"></a>
<a href="http://www.kuafuai.net"><img src="files/%E5%AE%98%E7%BD%91-%E4%BC%81%E4%B8%9A%E7%89%88-purple.svg" alt="EN doc"></a>
<a href="CONTACT.md"><img src="files/WeChat-%E5%BE%AE%E4%BF%A1-green.svg" alt="roadmap"></a>
</p>

### 💡 ヘルプ - [Q&A](https://github.com/kuafuai/DevOpsGPT/issues)
### 💡 リクエストの送信 - [Issue](https://github.com/kuafuai/DevOpsGPT/discussions)
### 💡 技術的交流 - [email protected]

<hr/>

## はじめに
AI Driven Software Development Automation Solution(略称: DevOpsGPT)へようこそ。LLM(大規模言語モデル)と DevOps ツールを組み合わせることで、自然言語による要求を実用的なソフトウェアに変換します。この革新的な機能により、開発効率の大幅な向上、開発サイクルの短縮、コミュニケーションコストの削減を実現し、より高品質なソフトウェアを提供します。

## 特長とメリット

- 開発効率の向上 面倒な要件文書の作成や説明は不要です。ユーザーは DevOpsGPT と直接やり取りすることで、要件を迅速に機能的なソフトウェアに変換できます。
- 開発サイクルの短縮: 自動化されたソフトウェア開発プロセスにより、納期が大幅に短縮され、ソフトウェアのデプロイとイテレーションが加速されます。
- コミュニケーションコストの削減: ユーザー要件を正確に理解することで、DevOpsGPT はコミュニケーションエラーや誤解のリスクを最小限に抑え、開発チームとビジネスチーム間のコラボレーション効率を高めます。
- 高品質の成果物: DevOpsGPT がコードを生成し、検証を行うことで、納品されるソフトウェアの品質と信頼性を確保します。
- [エンタープライズ版] 既存プロジェクト分析 AI により、既存プロジェクト情報を自動分析し、既存プロジェクトをベースに必要なタスクを正確に分解・開発します。
- [エンタープライズ版] 専門的なモデル選択: 専門分野のGPTより強力な言語モデルサービスをサポートし、より良い要件開発タスクを完成させ、プライベートな展開をサポートします。
- [エンタープライズ版] より多くの DevOps プラットフォームをサポート: より多くの DevOps プラットフォームと接続し、全プロセスの開発と展開を実現できます。

## デモ(クリックしてビデオを再生)

<a href="https://www.youtube.com/watch?v=IWUPbGrJQOU" target="_blank"><img src="docs/files/demo-adduser-en.jpeg" width="50%"></a>


## ワークフロー
上記の紹介とデモを通じて、DevOpsGPT が既存プロジェクトにおける要件開発の自動化プロセス全体をどのように実現しているのかに興味を持たれたことでしょう。以下は、プロセス全体の概要です:

![ワークフロー](docs/files/intro-flow-en.png)

- 要求文書の明確化 DevOpsGPT と対話し、要件ドキュメントの詳細を明確にし、確認する。
- インターフェース・ドキュメントの生成: DevOpsGPT は要件に基づいてインターフェース・ドキュメントを生成し、開発者のインターフェース設計と実装を容易にします。
- 既存のプロジェクトに基づいて擬似コードを記述する: 既存のプロジェクトを分析して対応する擬似コードを生成し、開発者にリファレンスと出発点を提供します。
- コード機能の洗練と最適化: 開発者は、生成されたコードに基づいて機能を改善し、最適化します。
- 継続的インテグレーション: 継続的インテグレーション用の DevOps ツールを活用し、コードの統合とテストを自動化する。
- ソフトウェアバージョンのリリース: DevOpsGPT と DevOps ツールを使用して、ソフトウェアバージョンをターゲット環境にデプロイする。

## クイックスタート

1. 最新のコードをクローンするか、リリースされたバージョンを選択します。
2. 設定ファイルを作成する: `env.yaml.tpl` をコピーし、`env.yaml` にリネームする。
3. 設定ファイルを修正する: 設定ファイルを修正する。`env.yaml` を編集し、GPT トークンなど必要な情報を追加する(詳細な手順は[ドキュメントリンク](docs/DOCUMENT.md)を参照)。
4. サービスを実行します: Linux や Mac では `sh run.sh` を、Windows では `run.bat` をダブルクリックする。
5. サービスにアクセスする: ブラウザからサービスにアクセスする(スタートアップログでアクセスアドレスを確認する、デフォルトは http://127.0.0.1:8080)。
6. 要件開発を完了する: ページの指示に従って要件開発を完了し、生成されたコードを `./workspace` ディレクトリに表示します。

詳細なドキュメントと設定パラメータについては、[ドキュメントリンク](docs/DOCUMENT.md)を参照してください。


## 制限事項
私たちは、大規模言語モデルの助けを借りて、エンタープライズレベルのソフトウェア開発効率を高め、障壁を低減するよう努めていますが、現在のバージョンにはまだいくつかの制限があります:

- 複雑なシナリオでは、要求とインターフェースドキュメントの生成は十分に正確でなく、開発者の意図を満たさない可能性があります。
- 現在のバージョンでは、既存のプロジェクト・コードの理解を自動化することはできません。私たちは、検証中に有望な結果を示した新しいソリューションを模索しており、将来のバージョンで導入する予定です。

## 製品ロードマップ

- 既存プロジェクトに基づく正確な要件分解と開発タスクのブレークダウン。
- 開発要求の迅速なインポート、ソフトウェア開発と配備の並行自動化のための新しい製品体験。
- より多くのソフトウェアエンジニアリングツールと専門的なツールを導入し、AI プランニングとエクゼキューションの下で様々なソフトウェア開発タスクを迅速に完了する。

DevOpsGPT プロジェクトに参加し、ソフトウェア開発の自動化と革新に[コントリビュート](./docs/CONTRIBUTING.md)することで、よりスマートで効率的なソフトウェアシステムを構築してください!

## 免責事項

このプロジェクト、DevOpsGPT は実験的なアプリケーションであり、明示または黙示を問わず、いかなる保証もなく「現状のまま」提供されます。このソフトウェアを使用することで、データ損失、システム障害、または発生する可能性のあるその他の問題を含め(ただし必ずしもこれらに限定されない)、その使用に関連するすべてのリスクを負うことに同意するものとします。

このプロジェクトの開発者および貢献者は、このソフトウェアを使用した結果生じる可能性のある損失、損害、その他の結果について、いかなる責任も負いません。DevOpsGPT によって提供された情報に基づいて行われた決定や行動については、利用者のみが責任を負うものとします。

GPT 言語モデルの使用は、そのトークン使用により高価になる可能性があることに注意してください。このプロジェクトを利用することで、利用者は自身のトークン使用量と関連コストを監視・管理する責任があることを認めることになります。定期的に OpenAI API の使用量をチェックし、予期せぬ課金を防ぐために必要な制限やアラートを設定することを強くお勧めします。

自律的な実験として、DevOpsGPT は、現実のビジネス慣行や法的要件に沿わないコンテンツを生成したり、行動を起こしたりする可能性があります。本ソフトウェアの出力に基づいて行われる行動や決定が、適用されるすべての法律、規制、および倫理基準に準拠していることを確認するのはあなたの責任です。このプロジェクトの開発者および貢献者は、このソフトウェアの使用から生じるいかなる結果に対しても責任を負いません。

DevOpsGPT を使用することにより、あなたは、このソフトウェアの使用またはこれらの条項の違反に起因するあらゆる請求、損害、損失、責任、費用、および経費(合理的な弁護士費用を含む)から、開発者、貢献者、および関連当事者を免責し、防御し、損害を与えないことに同意するものとします。

## 参考プロジェクト
- https://github.com/Significant-Gravitas/Auto-GPT
- https://github.com/AntonOsika/gpt-engineer
- https://github.com/hwchase17/langchain
1 change: 1 addition & 0 deletions docs/files/ドキュメント-日本語-blue.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.