ardware & Software
So my best feedback is as follows and to some regard is expanded in other annotations herein:
- Study how KBs for other similar products structure and format this type of reference doc. How does Microsoft do it? How does Apple do it? In short, sometimes you can borrow from the best—or at least borrow from the big ones because they've likely had a major impact on what readers may expect to see in your product KB.
- If breaking up the content into shorter docs so that each discrete product has its own requirements reference doc, then consider content layout alternatives so that all this good info isn't in one long doc that requires a lot of scrolling or use of Ctrl + F, or both.
- A consistent application of header levels within the doc can also help the reader visually and, if you deploy a header-based ToC option from KO, digitally navigate the sections.
- Using callouts (KO calls them alerts) can help ensure key precautions and warnings aren't lost in running article text.
- If they don't exist, consider creating some style guidelines for how to format/style UI elements, on-screen text, URLs, etc. so that this info is set off from regular article text. When a reader is scanning from some key technical tidbit or other, styling/formatting can help that reader more readily find it.