7 Matching Annotations
  1. Nov 2024
    1. 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.
    2. Use the links to jump to a certain section. SedonaOffice  SedonaOffice SQL Server  SedonaWeb System  SedonaDocs SedonaSync REST API & SedonaWeb 2.0 Sedona-X Mobile App  SedonaWeb 1.0 SedonaFSU (legacy)

      Have you considered using one of KO's doc ToC options in lieu of this...well, i see it's not an actual bulleted list but instead a series of paragraphs. A sticky ToC in a right-hand column would make this doc a bit more easy to navigate. https://support.knowledgeowl.com/help/article-table-of-contents

    1. Last Modified on 10/26/2023 3:41 pm EDT stages® stores Alarm History on all sites. In the

      There's some weird hyperlinking error happening in this highlighted text. Just looking at the source code in Chrome's developer tool, I can't figure out how/why that, at least for me, summons the Windows print preview dialog, is being applied so frequently.

    2. he Alarm Disposition should be entered during dispatch and can be edited using the Set Alarm Disposition Button Image at the beginning of the row. Setting the Alarm Disposition inserts an entry into the Event History

      Does this KB have style guidelines for how to refer to and style UI elements? Furthermore, does the KB have restrictions on the number of screenshots it can include?

    3. the alarm number, Priority, Alarm Event Code, the date and time of the alarm, the date and time the alarm was retrieved and locked by an operator, the time between the alarm generation and the retrieval, the time the alarm was cleared, the transmit# of the device, the Action Plan followed, the action plan's variation number if applicable, the initials of the operator who originally locked the account, and the disposition of the alarm if applicable

      This info might be better digestible in a bulleted list

    4. Out of curiousity, did you or whoever created this KB in KO consciously choose not to use Fancybox or some other zoom/enlarge functionality for media? I can grasp reasons why someone might choose not to use such functionality or to go the old-school route of thumbnail-ish images that link to the full-size image, so I'm just curious.