Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 

Repository files navigation

Product Documentation — Skill

Knowledge base & authoring guide untuk dokumentasi produk/perangkat lunak skala industri: 11 jenis dokumen, verifikasi istilah, template siap pakai, dan matriks keputusan "perlu atau tidak" berdasarkan skala proyek.

Skill ini membantu tim menentukan dokumen mana yang wajib dibuat (tanpa over-dokumentasi di proyek kecil, tanpa under-dokumentasi di proyek enterprise), menulisnya dengan template yang konsisten, dan memastikan penamaan sesuai konvensi industri (khususnya TRD.md dan AGENT.md yang sering ambigu).


Daftar Isi


Fitur

  • Katalog 11 dokumen: PRD, ROADMAP, PRODUCT.md, FSD, WIREFRAME, HLD, TRD/SDD, ERD, OPENAPI, DESIGN.md, AGENT.md.
  • Verifikasi istilah (references/glossary.md): status ✅ terverifikasi / ⚠️ perlu perhatian / 🔧 hasil upgrade, berbasis 17 sumber otoritatif (sources/bibliography.md).
  • Template siap pakai (references/doc-templates.md): kerangka Markdown + contoh terisi untuk tiap dokumen.
  • Matriks keputusan "perlu atau tidak" (references/synthesis.md): berdasarkan skala MVP / Menengah / Enterprise + anti-matrix (kapan JANGAN membuat dokumen).
  • Playbook cepat (references/synthesis.md §7): estimasi waktu per skala proyek.
  • Quality gates & checklist per dokumen.
  • DESIGN.md & PRODUCT.md standar industri: token spec Google Labs + semantic descriptions (Stitch) + anti-patterns (Impeccable).

Struktur Folder

skills/product-documentation/
├── SKILL.md                      # Entry point: katalog, matriks keputusan, workflow
├── references/
│   ├── synthesis.md              # Sintesis lengkap — MULAI DARI SINI
│   ├── glossary.md               # Verifikasi istilah 11 dokumen
│   ├── doc-templates.md          # Template Markdown + contoh
│   ├── product.md                # PRODUCT.md model Impeccable
│   ├── design-md.md              # DESIGN.md token spec + semantic
│   └── workflow.md               # Urutan produksi, RACI, versioning
└── sources/
    └── bibliography.md           # 17 sumber otoritatif + URL

Catatan penamaan: nama skill resmi (frontmatter name) adalah product-documentation. Saat memasang ke platform mana pun, gunakan nama folder product-documentation (bukan project-documentation) agar konsisten dengan frontmatter & sistem discovery.


Diagram Alur

Semua diagram pada skill ini menggunakan Mermaid agar bisa dirender otomatis oleh GitHub, GitLab, VS Code, Obsidian, dan tools AI.

1. Relasi Antar Dokumen

flowchart LR
    PRD[PRD.md] --> ROADMAP[ROADMAP.md]
    PRD --> PRODUCT[PRODUCT.md]
    PRD --> FSD[FSD.md]
    FSD --> HLD[HLD.md]
    HLD --> TRD[TRD/SDD.md]
    TRD --> ERD[ERD.md]
    TRD --> OPENAPI[OPENAPI.md]
    FSD --> WIREFRAME[WIREFRAME.md]
    WIREFRAME --> DESIGN[DESIGN.md]
    AGENT[AGENT.md]
Loading

2. Alur Informasi & Dependensi

flowchart TD
    PRODUCT["PRODUCT.md<br/><i>(strategic anchor)</i>"] --> PRD["PRD.md"]
    PRODUCT --> ROADMAP["ROADMAP.md"]
    PRODUCT --> WIREFRAME["WIREFRAME.md"]
    PRD --> FSD["FSD.md"]
    FSD --> DESIGN["DESIGN.md (paralel)"]
    FSD --> HLD["HLD.md"]
    HLD --> TRD["TRD/SDD.md"]
    TRD --> ERD["ERD.md"]
    TRD --> OPENAPI["OPENAPI.md"]
Loading

Aturan dependensi: dokumen tingkat bawah MEMBUTUHKAN dokumen tingkat atas sebagai input — jangan menulis ERD tanpa HLD, jangan menulis FSD tanpa PRD.


Cara Pasang

Skill ini kompatibel dengan Hermes Agent, Claude Code, dan Oh My Pi (omp) karena ketiganya memakai format SKILL.md + YAML frontmatter dengan layout <skills-root>/<skill-name>/SKILL.md.

1. Hermes Agent

Skill disimpan di $HERMES_HOME/skills/<skill-name>/SKILL.md. Default: ~/.hermes/skills/ (Linux/macOS) atau C:\Users\<user>\AppData\Local\hermes\skills\ (Windows).

Cara A — salin folder (paling sederhana):

# Linux / macOS
mkdir -p ~/.hermes/skills
cp -r skills/product-documentation ~/.hermes/skills/

# Windows (Git Bash / PowerShell)
# salin folder ke:
#   C:\Users\<user>\AppData\Local\hermes\skills\product-documentation

Cara B — via CLI (bila skill sudah di-hosting / repo GitHub):

hermes skills check                        # cek health & lokasi skills
hermes skills install <URL-SKILL.md>       # install dari URL langsung
hermes skills tap add <owner>/<repo>       # tambah repo sebagai sumber skill
hermes skills list                         # verifikasi skill terdeteksi

Cara C — preload per sesi (tanpa install permanen):

hermes --skills product-documentation

Referensi: hermes skills --help, atau dokumentasi resmi https://hermes-agent.nousresearch.com/docs/.

2. Claude Code

Skill Claude Code memakai layout <skill-name>/SKILL.md. Nama direktori menjadi nama command (/product-documentation).

Personal (semua project):

mkdir -p ~/.claude/skills/product-documentation
cp -r skills/product-documentation/* ~/.claude/skills/product-documentation/

Project (hanya repo ini):

mkdir -p .claude/skills
cp -r skills/product-documentation .claude/skills/

Verifikasi:

claude            # mulai sesi baru (restart bila folder skills belum ada saat session start)
/product-documentation   # atau minta Claude memakai skill secara otomatis via description

Claude Code mendeteksi perubahan file skill secara live tanpa restart (untuk folder ~/.claude/skills/ yang sudah ada). Bila folder skill baru dibuat setelah sesi berjalan, restart Claude Code sekali.

Referensi: https://code.claude.com/docs/en/skills

3. Oh My Pi (omp)

Oh My Pi membaca skill dengan layout non-rekursif <skills-root>/<skill-name>/SKILL.md dan wajib punya frontmatter name + description (sudah terpenuhi pada skill ini).

Beberapa lokasi yang didukung (prioritas tinggi → rendah):

Provider Lokasi Prioritas
native (.omp) project: .omp/skills/<name>/SKILL.md
user: ~/.omp/agent/skills/<name>/SKILL.md
100
omp-plugins ~/.omp/plugins/node_modules/.../skills/<name>/SKILL.md 90
claude .claude/skills/<name>/SKILL.md (project) / ~/.claude/skills/ (user) 80
agents (canonical OMP-native) .agent[s]/skills/<name>/SKILL.md (project) / ~/.agent[s]/skills/ (user) 70
codex .codex/skills/<name>/SKILL.md 70
opencode .opencode/skills/<name>/SKILL.md 55
github .github/skills/<name>/SKILL.md (project only) 30

Cara pasang (disarankan — lokasi native .omp):

# Project-level
mkdir -p .omp/skills
cp -r skills/product-documentation .omp/skills/

# atau user-level (semua project)
mkdir -p ~/.omp/agent/skills
cp -r skills/product-documentation ~/.omp/agent/skills/

Alternatif — lokasi agents (kanonik OMP-native):

mkdir -p .agents/skills
cp -r skills/product-documentation .agents/skills/

Akses skill di dalam sesi omp:

read skill://product-documentation              # baca SKILL.md
read skill://product-documentation/references/synthesis.md   # baca file referensi
/skill:product-documentation                    # jalankan skill via slash command

Pitfall: bila skill dengan nama sama ada di beberapa lokasi, yang menang adalah prioritas tertinggi (native 100 > claude 80 > agents 70 > ...). Pastikan hanya ada satu salinan product-documentation agar tidak ada warning collision.

Referensi: https://github.com/can1357/oh-my-pi/blob/main/docs/skills.md

Tabel Ringkas Semua Platform

Platform Lokasi install Perintah verifikasi
Hermes Agent $HERMES_HOME/skills/product-documentation/ hermes skills list
Claude Code (personal) ~/.claude/skills/product-documentation/ /product-documentation di sesi Claude
Claude Code (project) .claude/skills/product-documentation/ /product-documentation di sesi Claude
Oh My Pi (project native) .omp/skills/product-documentation/ read skill://product-documentation
Oh My Pi (user native) ~/.omp/agent/skills/product-documentation/ read skill://product-documentation
Oh My Pi (agents) .agents/skills/product-documentation/ read skill://product-documentation

Verifikasi Instalasi

  1. Pastikan file SKILL.md ada di <lokasi-install>/product-documentation/SKILL.md.
  2. Pastikan frontmatter memuat name: product-documentation dan description (non-kosong).
  3. Jalankan perintah verifikasi per platform (tabel di atas).
  4. Coba panggil skill: minta agent "tentukan dokumentasi yang wajib untuk proyek MVP", lalu bandingkan output dengan matriks keputusan di SKILL.md.

Cara Menggunakan Skill

Skill ini otomatis dikenal oleh agent setelah terpasang. Agent akan memuatnya secara otomatis ketika tugas berkaitan dengan perencanaan/penulisan dokumentasi produk, atau bisa dipanggil eksplisit melalui command per platform.

1. Memanggil / Mengaktifkan Skill

Platform Cara memanggil
Hermes Agent Preload saat sesi: hermes --skills product-documentation; atau cukup minta di chat: "pakai skill product-documentation untuk menentukan dokumen yang wajib di proyek MVP saya"
Claude Code Ketik /product-documentation langsung di sesi, atau minta dalam bahasa alami (Claude memuat otomatis sesuai description)
Oh My Pi (omp) read skill://product-documentation atau /skill:product-documentation

Skill bersifat on-demand (bukan alwaysApply), jadi biasanya dimuat per-percakapan saat topik dokumentasi muncul. Menyebut nama skill secara eksplisit membantu agent memuatnya lebih cepat.

2. Alur Kerja yang Disarankan

  1. Tentukan skala proyek (MVP / Menengah / Enterprise) → minta agent memilih dokumen wajib dari matriks keputusan. Contoh perintah:
    • "Kami tim 5 orang, buat daftar dokumen yang wajib kami tulis beserta alasannya."
  2. Pilih dokumen → agent merekomendasikan subset dari 11 dokumen (tanpa over-dokumentasi).
  3. Salin template → minta agent membuat file dari kerangka references/doc-templates.md.
  4. Verifikasi penamaan & istilah → agent cek references/glossary.md (khususnya TRD vs SDD/LLD dan AGENT.md vs AGENTS.md).
  5. Isi dokumen → agent menulis draf sesuai template (contoh terisi tersedia di template).
  6. Review lintas fungsi → PM, eng, design, QA (traceability untuk enterprise).
  7. Simpan & tautkan → simpan di docs/, tautkan dari README.md / AGENTS.md.

3. Contoh Permintaan yang Bisa Anda Ajukan

  • "Buat PRD untuk aplikasi task manager tim kecil (isi semua section wajib)."
  • "Tulis FSD dari PRD ini — include use cases dan validasi rules."
  • "Saya bingung TRD atau SDD yang benar untuk dokumen desain DB ini — bandingkan."
  • "Dari 11 jenis dokumen, tentukan mana yang wajib untuk aplikasi ini berdasarkan skala proyek."
  • "Buatkan DESIGN.md dengan 3 layer (YAML tokens + prose + anti-patterns)."

4. Baca Referensi Secara Manual

Skill didesain progresif — agent hanya membaca referensi yang diperlukan:

Butuh... Baca (skill:// pada omp / file di Hermes & Claude)
Gambaran besar / sintesis lengkap references/synthesis.md
Verifikasi istilah references/glossary.md
Template kosong per dokumen references/doc-templates.md
Detail PRODUCT.md (Impeccable) references/product.md
Detail DESIGN.md references/design-md.md
Urutan produksi & RACI references/workflow.md
Sumber otoritatif & URL sources/bibliography.md

Aturan emas: hanya buat doc yang punya pembaca nyata & keputusan yang ditunda. Bila tidak, lewati — skill menilai bukan berarti tidak boleh.


Komunitas

Bergabunglah dengan grup kami: Isekai Coders & Vibe Engineering 👉 Discord — klik untuk bergabung

Deskripsi Group: Isekai Coders & Vibe Engineering

Grup ini didirikan sebagai ruang kolaborasi dan inkubator bagi para kreator untuk mengubah imajinasi menjadi solusi nyata, sekaligus melatih mentalitas kepemimpinan strategis. Pergerakan dibangun di atas dua pilar:

  • Isekai Coders — jembatan antara "dunia ide" dan dunia nyata: membawa gagasan dari sisi lain pikiran untuk direalisasikan menjadi karya/teknologi yang praktis, fungsional, dan memberi kemudahan dalam kehidupan sehari-hari.
  • Vibe Engineering — evolusi dari sekadar menulis kode (vibe coders): melatih pola pikir strategis, menyusun roadmap terstruktur demi target (goals), dan merancang solusi + memimpin visi layaknya Enterprise Architect atau CEO.

Visi: Mengeksekusi ide dari "dunia lain" menjadi kenyataan lewat perpaduan coding yang brilian dan perencanaan strategis tingkat tinggi.

Misi: Evolusi & realisasi — mengangkat gagasan menjadi solusi yang berdampak.


Lisensi

MIT — sama dengan lisensi pada frontmatter SKILL.md. Sumber otoritatif & atribusi per istilah: sources/bibliography.md.

About

Skill AI agent untuk merencanakan & menulis dokumentasi produk — 11 jenis dokumen, verifikasi istilah, template siap pakai, dan matriks keputusan 'perlu atau tidak' berdasarkan skala proyek.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors