Menü
技術ドキュメント作成ガイド。README、ユーザーガイド、API参照に使用。
Mit Codex oder Claude installieren Kopieren Sie diesen Prompt, fügen Sie ihn in Codex, Claude oder einen anderen Assistant ein und lassen Sie die Skill-Seite prüfen und installieren.
Basierend auf der SOC-Berufsklassifikation
Architecture Decision Records作成ガイド。技術選定・設計判断のドキュメント化に使用。
MUSUBIX学習済み17ベストプラクティスガイド。コード・設計・テストパターンの適用に使用。
C4モデル設計ドキュメント作成ガイド。アーキテクチャ図・コンポーネント設計に使用。
設計仕様からコード生成ガイド。実装・機能作成に使用。
自動ドメイン検出・コンポーネント推論ガイド。プロジェクトドメイン特定に使用。
EARS形式要件の検証・作成ガイド。要件記述・構文検証に使用。
| name | musubix-technical-writing |
| description | 技術ドキュメント作成ガイド。README、ユーザーガイド、API参照に使用。 |
| license | MIT |
高品質な技術ドキュメントを一貫した構造で作成。
| 種類 | 目的 | ファイル |
|---|---|---|
| README | プロジェクト概要 | README.md |
| Install Guide | セットアップ手順 | INSTALL-GUIDE.md |
| User Guide | 使用方法詳細 | USER-GUIDE.md |
| API Reference | API完全ドキュメント | API-REFERENCE.md |
| Changelog | バージョン履歴 | CHANGELOG.md |
| WHEN | DO |
|---|---|
| 新規プロジェクト | READMEテンプレート適用 |
| 機能追加 | User GuideとAPI Reference更新 |
| リリース | Changelog更新 |
| セットアップ手順変更 | Install Guide更新 |
# Project Name
> One-line description
## 🎯 Features
- Feature 1
- Feature 2
## 📦 Installation
\`\`\`bash
npm install package-name
\`\`\`
## 🚀 Quick Start
\`\`\`typescript
import { MainClass } from 'package-name';
const instance = new MainClass();
\`\`\`
## 📖 Documentation
- [Installation](docs/INSTALL-GUIDE.md)
- [User Guide](docs/USER-GUIDE.md)
- [API Reference](docs/API-REFERENCE.md)
### `methodName(param1, param2)`
Description.
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `param1` | `string` | Yes | First param |
| `param2` | `number` | No | Optional |
**Returns**: `Promise<Result>`
**Example**:
\`\`\`typescript
const result = await instance.methodName('value', 42);
\`\`\`
## [1.2.0] - 2026-01-15
### Added
- New feature description
### Changed
- Modified behavior
### Fixed
- Bug fix description
┌─────────────────────────────────────────┐
│ Documentation Generated │
├─────────────────────────────────────────┤
│ README.md: Updated │
│ INSTALL-GUIDE.md: Created │
│ USER-GUIDE.md: Updated │
│ API-REFERENCE.md: Updated │
│ CHANGELOG.md: Updated │
│ Total Sections: 15 │
└─────────────────────────────────────────┘