Getting Started
Getting Started page with structure, conventions, and recommended workflows for AFANDI Docs.
Quick overview
This page describes the working standard for Getting Started – with a focus on concrete decisions rather than general guidance.
The main focus here is which entry point fits which task and when a documentation page vs. a template is used so that teams apply the same standard.
The standard only becomes traceable through linked evidence such as defined start paths and through documented edge cases/exceptions.
When this page helps
Typical situations in which this page adds value as a working document, and where another document is more appropriate.
Typical use cases
- when Getting Started as standard with clear scope (entry paths by target audience) described be should
- when decisions about which entry point fits which task must be made consistently
- when evidence such as linked start paths should be referenced on the page
- when typical error patterns such as users start in the wrong area and lose time should be reduced
Less suitable when
- when Getting Started only about a one-off individual case without need for standardization applies
- when a detailed project ticket or a technical step-by-step guide is the better fit
Recommended process
A pragmatic sequence that works in practice, from scope to review.
- scope and goal from Getting Started clarify.
- Document the standard decisions about which entry point fits each task.
- Define the evidence and link the relevant start paths.
- Document exceptions and set a review date.
- Review the page against real cases and common pitfalls.
Decision rules
Getting Started is well documented, when rules, Edge cases and Evidence so clearly are, dass teams so that without additional coordination work can.
standard case
For Getting Started first define the scope clearly: Getting Startedspfade after Target audience.
approval & roles
decisions about which entry point fits which task and when a documentation page vs. a template is used not implizit lassen, sondern roles and approvals explicitly benennen.
Edge cases
Allow exceptions only if they do not dilute the standard; especially relevant here are important categories and search terms.
Control point
Verifiable is the rule only, when linked start paths and category overview cleanly verlinkt are.
What should be documented
Here only the spezifischen Inhalte about Getting Started maintain; general documentation rules remain in the centraln guideline. Central guideline.
The page is good when a substitute can apply or review the standard without first collecting tribal knowledge.
Definitions
terms, scope and boundaries about Getting Started specify in concrete terms, including entry paths by target audience.
Standardkonfiguration / Prozess
Den standard so record, dass which entry point fits which task and such as new seiten einsortiert be eindeutig entschieden are.
evidence
Name and link evidence directly: linked Homepfade, category overview, maintenance notes for new pages.
Review status
Aktive Exceptions, the latest change and the next review belong on the page—especially for topics with important categories and search terms.
Common pitfalls
This section captures real-world pitfalls from Getting Started; general guidance belongs in the central guideline. Central guideline.
- scope driftet: users starten in the wrong area and lose time.
- the rule is too abstract: Search findet pages without klare Kurzbeschreibung.
- evidence is missing: new pages landen without Kontext in the Index.
- the exception gets out of control: new pages landen without Kontext in the Index.
Review & maintenance
Check this Page gegen reale processes about Getting Started – not only gegen the Wortlaut. Entscheidend is, ob standard, Exceptions and Evidence in the Alltag contribute.
- Funktionieren Getting Startedspfade in the practice?
- Are Kurztexte verständlich and unterscheidbar?
- Ist the Navigation fully?
- Are Evidence and decisions about Getting Started weiterhin fully and auffindbar?
Review focus for „Getting Started“: Orientierung; check especially entry paths by target audience.
Useful metrics
A few metrics are enough – what matters is that they trigger decisions or improvements.
For „Getting Started“ Kennzahlen directly an which entry point fits which task and the most frequent Praxisrisiken koppeln.
Suchtreffer-Nützlichkeit
Anteil Suchtreffer, the directly to the richtigen Page führen
Interval: quarterly
Absprünge from Homeseite
users springen mehrfach without passende Page
Interval: quarterly
Pflegegrad Index
Anteil entries with aktuellem Kurztext
Interval: quarterly
Next steps
Add jetzt the concrete Entscheidung about which entry point fits which task incl. Verantwortlichen, Datum and Verweis on linked start paths.
On „Getting Started“ make especially clear as the next step: which entry paths by target audience apply in the standard case and which exceptions are time-limited.