Panduan Penulisan Dokumen YYZU

Pendahuluan

Konsistensi dokumentasi dimulai dari standar yang jelas. Dokumen ini menetapkan format metadata, panduan gaya penulisan, dan standar penamaan yang berlaku untuk seluruh dokumentasi YYZU, agar mudah dibaca manusia dan diproses oleh AI Agent.

Daftar Isi

Pendahuluan
Tujuan dan Ruang Lingkup
Standar Metadata Dokumen (Ownership)
Panduan Gaya Penulisan dan Karakter (Style Guide)
Standar Penamaan dan Tautan Halaman (Naming dan Linking)
Kriteria Keberhasilan dan Audit

1. Tujuan dan Ruang Lingkup

Dokumen ini menetapkan standar penulisan (style guide) dan struktur metadata resmi untuk seluruh dokumentasi di ekosistem YYZU. Standar ini dibuat agar:

Seluruh dokumen memiliki konsistensi visual dan struktural yang tinggi.
Dokumen mudah dibaca oleh manusia (member dan mentor) serta mudah diproses secara akurat oleh AI Agent (AI Mentor dan AI Assessor).
Kepemilikan dan riwayat pembaruan setiap dokumen terlacak dengan jelas.

2. Standar Metadata Dokumen (Ownership)

Setiap dokumen resmi di ekosistem YYZU wajib memiliki tabel metadata di bagian paling atas dengan format sebagai berikut:

Field	Deskripsi/Nilai yang Diizinkan
Tipe Dokumen	Kategori dokumen (contoh: Blueprint Induk, Foundational Reference, Operational Standard, Operational Guide, Framework Operasional)
Owner	Nama peran/jabatan yang bertanggung jawab atas isi dokumen (contoh: Founder YYZU, Divisi SDM YYZU, Divisi PM YYZU)
Parent	Nama dokumen induk jika merupakan child page (opsional)
Berlaku untuk	Lingkup penerapan dokumen (contoh: Seluruh member, Mentor, atau project tertentu)
Review	Frekuensi peninjauan ulang dokumen (contoh: Ulasan Tahunan, Per batch, atau Sesuai RFC)
Status	Versi dan status keaktifan dokumen (contoh: v1.0 - Active, v2.1 - Draft, Deprecated, Archived)

3. Panduan Gaya Penulisan dan Karakter (Style Guide)

Untuk memastikan kompatibilitas tinggi lintas editor (Notion, GitHub, VS Code, Obsidian) dan efisiensi pemrosesan AI, kontributor wajib mengikuti aturan berikut:

A. Karakter yang Dilarang

Jangan menggunakan karakter dekoratif atau non-standar keyboard berikut:

Dilarang: Em dash ("--") atau en dash ("-"). Gunakan: Hyphen standar ("-").
Dilarang: Unicode ellipsis ("..."). Gunakan: Tiga titik standar ("...").
Dilarang: Smart quotes / curly quotes (curly double/single quotes). Gunakan: Quotation marks standar (" ") dan apostrophe standar (' ').

B. Heading dan Hierarki Dokumen

Gunakan struktur heading yang logis: H1 (#) hanya untuk judul utama halaman (hanya satu per halaman).
Gunakan H2 (##) untuk bab-bab utama dan H3 (###) untuk sub-bab. Hindari kedalaman heading melebihi H4.
Gunakan pembatas horizontal ("---") untuk memisahkan antara metadata table dengan konten, dan antara section utama jika diperlukan.

C. Bullet List dan Penomoran

Gunakan bullet list standar ("- Item") untuk daftar tanpa urutan.
Gunakan penomoran standar ("1. Step") untuk alur kerja atau prosedur langkah-demi-langkah.
Hindari penggunaan simbol unicode khusus sebagai bullet point.

D. Penggunaan Callout

Gunakan callout block Notion secara strategis untuk informasi penting, tips, atau peringatan:
- Gunakan label [!NOTE] untuk catatan tambahan.
- Gunakan label [!IMPORTANT] atau [!WARNING] untuk instruksi kritis.

E. Formatting Teks

Bold (**text**): Gunakan untuk istilah teknis, nama kompetensi, dan label field metadata. Contoh: API, State Management, Acceptance Criteria.
Italic (*text*): Gunakan untuk penekanan konsep atau istilah asing yang belum umum. Contoh: transferability, cross-track collaboration.
Code (`text`): Gunakan untuk nama file, nama fitur, command, atau kode. Contoh: README.md, sprint planning, git push.
Hindari penggunaan bold secara berlebihan. Bold hanya untuk istilah yang benar-benar perlu ditekankan.

F. Panduan Bahasa

Dokumen YYZU ditulis dalam Bahasa Indonesia dengan pengecualian istilah teknis yang sudah umum digunakan dalam industri teknologi.

Aturan Penggunaan Bahasa:

Bahasa Indonesia: Gunakan untuk kalimat deskripsi, penjelasan, dan instruksi.
Istilah Teknis (Boleh Inggris): API, SDK, CLI, Git, Docker, Kubernetes, CI/CD, SQL, JSON, YAML, HTTP, HTTPS, URL, HTML, CSS, JavaScript, TypeScript, React, Vue, Angular, Node.js, Python, Java, Go, Rust, AWS, GCP, Azure, Figma, VS Code, IntelliJ.
Istilah Campuran: Gunakan bentuk yang paling umum digunakan di industri. Contoh: product-market fit, go-to-market, design system, code review.
Kesalahan Umum: Jangan gunakan "and" sebagai konjungsi dalam kalimat Indonesia. Gunakan "dan". Contoh: "Frontend and Backend" seharusnya "Frontend dan Backend".

4. Standar Penamaan dan Tautan Halaman (Naming dan Linking)

Judul Halaman: Gunakan format huruf kapital pada setiap awal kata (Title Case) (contoh: "Assessment Standard YYZU").
Tautan (Links): Saat mereferensikan dokumen lain, gunakan tautan yang valid. Teks tautan harus merupakan nama resmi dokumen tanpa menggunakan format kode / backticks (contoh: Kurikulum Member YYZU - bukan Kurikulum Member YYZU).

Contoh Penamaan yang Benar:

YYZU Learning Architecture
Onboarding Pathway YYZU
Assessment Standard YYZU

Contoh Link yang Benar:

Lihat Knowledge Architecture YYZU untuk detail.

5. Kriteria Keberhasilan dan Audit

Setiap dokumen yang dipublikasikan akan dievaluasi oleh Divisi PM atau Founder berdasarkan checklist berikut:

Apakah tabel metadata kepemilikan sudah ada di baris pertama?
Apakah semua tautan internal berfungsi dengan baik?
Apakah dokumen bersih dari em dash, en dash, unicode ellipsis, dan smart quotes?
Apakah struktur heading sudah berurutan secara logis?
Apakah dokumen bersih dari bahasa campur ("and" diganti "dan")?
Apakah format bold, italic, dan code sudah sesuai aturan?
Apakah istilah teknis sudah menggunakan format yang benar?

Referensi Dokumen Terkait

YYZU Global Terminology Dictionary - Definisi istilah pendidikan
Glosarium YYZU - Definisi seluruh istilah ekosistem
Learning Architecture - Blueprint induk pendidikan
Kurikulum Talenta - Standar kompetensi per track