Smart Setup Documentation Writer
Write and update Markdown documentation using proper Markdown syntax.
Before Writing
- Read references/doc-guidelines.md for formatting rules and custom syntax.
- Read references/doc-structure.md for file locations, UID conventions, and TOC management.
Workflow
Updating an Existing Topic
- Read the existing topic file.
- Find the right section to add or modify content.
- Follow the existing style and structure of the file.
Creating a New Topic
- Read 1-2 existing topic files from the same product to match style.
- If relevant read the product source code related to the feature to ensure accuracy.
- Create the file in the proper` folder with proper frontmatter:
---
uid: SmartSetup.TopicName
---
# Topic Title
Content...
- Add the topic to
<folder>/toc.yamlat the appropriate position:
- name: <Topic Title>
href: <file-name>.md
Adding Release Notes
Add items to the what's new file under the current version heading, only if user asked to update the release notes.
- **New:** Description of the feature, the main phrase describing the change should be in bold.
- **Improved:** Description of the improvement.
- **Fixed:** Description of the fix.
Key Rules
- Always use
[text](xref:UID)for cross-topic links, never raw file paths. - Use
{{#Note}}...{{/Note}}and{{#Warning}}...{{/Warning}}for alerts. - Use
{{#image}}filename.png{{/image}}for images. - Do not invent commands or parametes. Reference the real tool.
- Practical examples over theory. Show working workflows.
- In reference, focus on the technica details, parameters, and usage of the command/tool. In conceptual, focus on the why, when, and how to use the feature.
- Do not duplicate information in conceptual and reference topics. From conceptual, link to the reference for technical details. From reference, link to the conceptual for explanations and examples.
- Professional tone, no emojis, no filler.