USAGE INFORMATION QUESTION
- Should natural language be used to write "Usage information" sections? I see a mix in the existing "Usage information" sections.
Usage information section (written with natural language)
Usage information
Book maps consist of references to topics organized as book content. The topic references therefore are labeled according to the book components they point to, such as book title, front matter, chapter, and appendix.
Usage information section (not written with natural language)
Usage information
The <msgblock> element can contain multiple message numbers and message descriptions, each enclosed in <msgnum> and <msgph> elements. It can also contain the message content directly.
EXAMPLE QUESTIONS
- The example section of some elements includes an xref to another element topic. Should those be removed and replaced with inline examples?
- If we want reuse other examples, can we conref them in vs link to them?
Cheers,
Tammy
| tammy crowley information architect |
  |  |
 180 John St. Toronto, ON Canada M5T 1X5 T: (437) 317-0802 tammy@precisioncontent.com | ||
This email and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you are not the intended recipient you are notified that disclosing, copying, distributing or taking any action in reliance on the contents of this information is strictly prohibited. Please notify us by return email if you have received this email in error. ©2023, Precision Content, Toronto, Ontario, Canada | ||