DITA: Notes
<note type="tip">Don't fasten the bolts too tightly. First make sure all the pieces
fit well together, and then tighten them down firmly.</note>There are actually quite a few options for note types: attention, danger, fastpath, important, notice, other, remember, restriction, tip, warning.
Sponsored
Some of the types have different icons and formatting associated with them. All of notes transform to HTML with a class corresponding with their name.
If you're adding a note inside a task list, add the note inside the info
element.
fig
element:
<fig><title>Bolt Warning</title>
<note type="tip">Don't fasten the bolts too tightly.
First make sure all the pieces fit well together, and then tighten them down firmly.</note>
</fig>About Tom Johnson
I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, agent skills, tech comm careers, and more. Check out my AI courses for more on the latest in AI and tech comm. If you're looking for info about documenting APIs, see my API documentation course.
If you're a technical writer and want to keep on top of the latest trends in tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me.
Finally, I want to note a couple of things. I usually write the first drafts of my posts myself and then use AI to improve accuracy, clarity, and detail in places, so my writing is a mix of human and AI. (Hopefully that's not too off-putting.) Also, the opinions I express on my blog are my own perspectives, not those of my employer.