2 min readAn original planning guide. Use the linked primary documentation for platform details and the supported procedure for your environment.
Define voice and reader level
Describe how directly the site addresses readers and which technical terms need explanation. Include short examples of suitable language.
Standardize repeated details
Choose conventions for product names, dates, measurements, links, buttons, and factual claims. Keep a maintained source for shared business facts.
Describe useful structures
Show when to use a definition, ordered procedure, checklist, comparison, or example. Choose a structure that fits the content.
Set review responsibilities
Name who checks factual accuracy, sources, accessibility, and final publishing. Record how obsolete instructions and broken links are corrected.
Worked scenario
See the plan in practice.
A glossary entry needs a precise definition and distinction, while a migration guide needs an ordered plan. Shared tone does not require identical page structure.
Review your result
Your acceptance checklist
Conventions practical- Facts sourced
- Reviews assigned
Use these checks to identify gaps in your editorial style sheet. Assign an owner to any unresolved item before the next dependent step.
The terms behind the task
- Content management systemSoftware for organizing, editing, and publishing content through an application interface.
- Anchor textThe readable text of a hyperlink that communicates something about its destination.
- Alt textA text alternative that communicates an image's information or function when the image is not perceived.
Primary references
For the underlying concepts and current platform details:
