Project HuntBlox Documentation Standard

Document Metadata

Version

1.0.0

Status

APPROVED

Priority

★★★★★ (Critical)

PURPOSE

Dokumen ini mendefinisikan standar penulisan seluruh dokumentasi PROJECT HUNTBLOX.

Semua dokumen resmi wajib mengikuti standar yang ditetapkan pada PHDS.

PHDS merupakan fondasi utama dokumentasi proyek.

DOCUMENT CATEGORIES

• Seluruh dokumentasi dikelompokkan sebagai berikut.
• PHDS = Project HuntBlox Documentation Standard
• CDR = Core Design Rules
• GDD = Game Design Document
• MDD = Master Data Document
• GDS = Game Data Sheet
• TDD = Technical Design Document
• API = API Documentation
• DN = Design Note
• LOG = Changelog / Development Log

DOCUMENT STATUS

• Status yang diperbolehkan.
• 🟡 Proposed
• 🟢 Approved
• 🔵 Implemented
• 🟠 Testing
• 🔴 Deprecated

VERSIONING

• Seluruh dokumen menggunakan Semantic Version.
• Major.Minor.Patch
• Contoh:
• 1.0.0
• 1.1.0
• 2.0.0

DOCUMENT HEADER

• Seluruh dokumen wajib memiliki Header.
• Project Name
• Document ID
• Document Title
• Version
• Status
• Priority

DOCUMENT FOOTER

• Seluruh dokumen wajib memiliki Footer.
• Dependencies
• Revision History
• Approval
• START COPY / END COPY Marker

DOCUMENT NUMBERING

• Nomor dokumen bersifat permanen.
• Contoh.
• GDD-01
• GDD-02
• MDD-01
• MDD-02
• CDR-01
• Nomor tidak boleh diubah setelah dipublikasikan.

WRITING STANDARD

• Gunakan bahasa yang jelas.
• Hindari kalimat ambigu.
• Gunakan istilah yang konsisten.
• Satu dokumen hanya membahas satu sistem.

DESIGN NOTES

Ide yang belum disetujui tidak masuk GDD.

Seluruh ide disimpan sebagai DN (Design Note).

DN dapat dipromosikan menjadi GDD setelah disetujui.

DOCUMENT OWNERSHIP

• Lead Game Designer
• Bertanggung jawab terhadap kualitas desain.
• Producer
• Bertanggung jawab terhadap keputusan akhir proyek.

APPROVAL

• Lead Game Designer
• ☑ Approved
• Producer
• ☑ Approved