docs

Promps Documentation

Version: v0.0.3-2 (Phase 3-First Half) Last Updated: 2026-01-19 (JST)

---

Language / 言語

• English - English documentation index
• 日本語 - 日本語ドキュメント目次

---

Directory Structure / ディレクトリ構成

docs/
├── INDEX_ja.md          # 日本語目次
├── INDEX_en.md          # English index
├── design/              # Design documents / 設計ドキュメント
│   ├── ARCHITECTURE.md
│   └── ARCHITECTURE_en.md
├── developer/           # Developer documentation / 開発者向け
│   ├── ja/
│   │   ├── api/         # API reference
│   │   ├── contributor/ # Contributor guides
│   │   ├── design/      # Design details
│   │   ├── guides/      # Development guides
│   │   └── setup/       # Setup guides
│   └── en/
│       ├── api/
│       ├── design/
│       └── guides/
├── user/                # User documentation / ユーザー向け
│   ├── ja/
│   └── en/
├── testing/             # Test documentation / テストドキュメント
│   ├── ja/
│   └── en/
├── security/            # Security documentation / セキュリティ
└── etc/                 # Miscellaneous / その他

---

Quick Links / クイックリンク

English

• Core Features - Feature documentation
• API Reference - Complete API reference
• Architecture - System architecture

日本語

• コア機能 - 機能ドキュメント
• API リファレンス - 完全な API 仕様書
• アーキテクチャ - システムアーキテクチャ
• ユーザーガイド - 使い方ガイド

Contributor / コントリビューター向け

• API Stability - API 安定性ポリシー
• Branching Strategy - ブランチ戦略

---

About Promps

Promps is a DSL (Domain Specific Language) to Natural Language translator for AI prompt generation.

Promps は、AI プロンプト生成のための DSL（ドメイン固有言語）から自然言語への翻訳ツールです。

---

Project Links

• GitHub: https://github.com/BonoJovi/Promps
• Issues: https://github.com/BonoJovi/Promps/issues
• Email: promps-dev@zundou.org

---

Built with [Heart] using data-driven thinking and AI collaboration