Bỏ qua để đến nội dung
DOL Wiki

Feature-master Template

CommandTemplates460 words2 min read
active

Purpose

Phần tiêu đề “Purpose”
  • Template cho doc_role: feature-master - file owner one-stop cho cross-surface features.
  • Giảm phân mảnh logic khi feature chạm nhiều surface/page.
  • Dựa trên exemplar thực tế: ENG_Navigation_00_Overview.md.

When to Use

Phần tiêu đề “When to Use”
  • Feature logic rải qua >= 3 files (page docs, contracts, decisions).
  • Feature chạm >= 2 surfaces (Home, LM, Vocabulary, …).
  • Cần 1 file để người đọc/AI hiểu toàn bộ current truth mà không phải tổng hợp từ đầu.

When NOT to Use

Phần tiêu đề “When NOT to Use”
  • Feature chỉ sống trong 1 page → dùng page-spec thay.
  • Feature chưa có logic rõ (đang discovery) → dùng discovery-log.
  • Overview thuần routing (không chứa logic riêng) → dùng canonical-map.

Template Structure

Phần tiêu đề “Template Structure”
---
title: "<Domain> - <Feature> Overview"
slug: "<domain>-<feature>-00-overview"
updated: YYYY-MM-DD
status: active
owner: <team>
doc_role: feature-master
---


# <Domain> - <Feature> Overview


## Purpose
- One-stop entry cho toàn bộ logic <feature> của <audience>.
- [User problem being solved]
- [Success signal: reader understands current truth from this file alone]


## Doc Role
- Đây là feature-master của <feature>.
- Nếu chỉ đọc 1 file để hiểu toàn bộ logic hiện tại, đọc file này trước.
- Các file bên dưới chỉ mở khi cần đi sâu vào rule hoặc owner surface cụ thể.


## Feature Scope
- [What's included - surfaces, modules, behaviors]
- [What's NOT included - pixel spec, screen inventory, etc.]


## Current Truth
- [Core logic/rules currently active]
- [Key constraints or boundaries]


## Elements
- [In-scope modules/entities this feature touches]


## Logic
- [Cross-surface rules that apply everywhere]
- [Per-surface exceptions if any - brief, point to page-spec for detail]


## Reading Order
| Priority | File | Role |
|----------|------|------|
| 1 | This file | Feature-master: current truth |
| 2 | ... | Owner doc: <surface> detail |
| 3 | ... | Supporting: contracts/rules |


## Change log
- YYYY-MM-DD: <impact summary>

Checklist

Phần tiêu đề “Checklist”
  • doc_role: feature-master in frontmatter?
  • Purpose có 3 ý (problem, audience, success signal)?
  • Doc Role section nêu rõ “đọc file này trước”?
  • Feature Scope phân biệt rõ included vs. excluded?
  • Current Truth phản ánh logic đang active, không phải planned?
  • Logic chỉ chứa cross-surface rules, không duplicate page-spec detail?
  • Reading Order liệt kê owner docs + supporting docs?
  • Owner/supporting docs có reading rule trỏ ngược về file này?

Anti-patterns

Phần tiêu đề “Anti-patterns”
  • Nhồi toàn bộ page-spec detail vào feature-master → giữ ngắn, delegate to owner docs.
  • Chỉ list links mà không có logic summary → thiếu current truth, thành canonical-map.
  • Feature-master mà không ai link tới → orphan, cần gắn vào workspace overview.

References

Phần tiêu đề “References”