๐๏ธ Procedures
A procedure is a numbered list of sequential actions that a reader can follow to complete a task. Using consistent formatting for procedures helps users identify tasks and follow stepsinstructions.
Learn how to write different kinds of content, including error messages, code examples, and release notes.
A procedure is a numbered list of sequential actions that a reader can follow to complete a task. Using consistent formatting for procedures helps users identify tasks and follow stepsinstructions.
The quality of release notes and changelogs can determine how much users trust new features, and how much they trust Unity. To support quality and consistency in your work and within your team, share this document and encourage everybody to follow the same standards.
4 items
Writing error messages and solutions in a consistent format helps users to identify and resolve issues.
Whether and how to write FAQs depends on what kind of content youโre creating. Specifically, there are different guidelines for technical documentation than for other types of content, such as marketing or technical support.
For guidance on writing API documentation, including templates and examples, refer to the Documentation Confluence: API reference pages.
2 items