Documentation template
Use this outline when documenting an approved Mearie tool. Replace the prompts below before publishing a real article.
At a glance
Section titled “At a glance”- Purpose: Describe the job the tool performs.
- Audience: State who should use it.
- Owner: Name the MediaTown or Mearie maintainer.
- Current version: Add the released version and date.
Before you begin
Section titled “Before you begin”List the account access and any materials the reader needs. Do not paste passwords or API keys into documentation.
Complete the task
Section titled “Complete the task”- Start with the action the reader takes.
- Describe what they should see.
- State how to confirm the task succeeded.
Troubleshooting
Section titled “Troubleshooting”Explain common symptoms, likely causes, and safe next steps. Give a support path for anything that requires an administrator.
Related guides
Section titled “Related guides”Link to the next task, technical reference, and relevant release notes.