A new look for our documentation

Technical documentation has come a long way from the days of printed data sheets. Working as a software engineer, I remember seeing data books get thicker year after year while the pages got thinner!

Fortunately PDFs took over and are still the most common way to get documentation today. This is what we have been using for our modules and development kits. Until now.

We have recently moved all our documentation online and are using Confluence to host our pages.

You can access documentation for each product from the “Documentation” tab on the product pages, or at http://devicesolutions.net/docs

The biggest reason to move to the online system was updates. We can easily add new content or fix issues without having to publish a new pdf every time.

image

It is also easier to search for the information you need, and we can include links to information such as schematics and sample code.

As you can see from the image to the left, information is organised by product and by module/development kit. There is also the search box at the top which is a great shortcut to find what you need in a hurry.

This next image shows the Quartz module main page. Most pages have a contents link on the right hand side for quickly skipping to the item you are interested in.

image

Another key feature about using an online tool is feedback. At the bottom of each page you can leave a comment. This is for anything on your mind – technical questions, something missing in the docs or if you spot a typo.

If you really need a pdf, there is an option under the Tools menu (top right hand side of each page) to export to PDF or Word. This exports the current page only and not the child pages.

If you made it this far, you obviouly have some interest in how documentation is presented!  Let us know what you think by taking the survey below or leaving a comment.

[polldaddy poll=7877900]

Leave a Reply

Be the First to Comment!

Notify of
wpDiscuz
http://devicesolutions.net/a-new-look-for-our-documentation/
devicesolutions.net
CC-MAIN-2024-18
44299
application/http; msgtype=response
sha1:B3CSRECGNOYLJKYSXDMCNTJ6QDQT2WMS
<urn:uuid:57632aa1-fbe4-43d4-bc24-e2a6fc025713>
2024-04-18T16:43:04Z
208.88.77.248
text/html
sha1:34ZOHKTYEMH4FEIUWKY7X7B2NLCPWG5R
<urn:uuid:940ddb24-20ea-4b66-895d-b743482eb470>
http://devicesolutions.net/a-new-look-for-our-documentation/
response
<urn:uuid:b23feb74-dec7-4a07-8b1a-dced9cfaa9ab>
isPartOf: CC-MAIN-2024-18
publisher: Common Crawl
description: Wide crawl of the web for April 2024
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-47
software: Apache Nutch 1.19 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.5-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/