Must documentation always follow the UI?

Subject: Must documentation always follow the UI?
From: "Cardimon, Craig" <ccardimon -at- M-S-G -dot- com>
To: "'TechWhirl (techwr-l -at- lists -dot- techwr-l -dot- com)'" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 23 Sep 2015 19:18:08 +0000

Hello, Whirlers,

How important is it that documentation exactly follow the interface?

Hypothetical question: On the landing page of an application, functions are laid out in non-alphabetical order. There doesn't *seem* to be a functional reason for laying it out the way it is. Maybe they were developed in this order. Let's say it looks a bit random. Something like this:


* Crotons

* Abercrombie

* Donuts

* Fish

* Ectoplasm

* Birds

* Guppies

I was thinking that if I were writing the documentation, that I might lay out the docs in alphabetical order, to be more pleasing to the eye. Something like this:


* Abercrombie

* Birds

* Crotons

* Donuts

* Ectoplasm

* Fish

* Guppies

What would you all handle this situation?

Cordially,
Craig Cardimon | Senior Technical Writer


Information contained in this e-mail transmission is privileged and confidential. If you are not the intended recipient of this email, do not read, distribute or reproduce this transmission (including any attachments). If you have received this e-mail in error, please immediately notify the sender by telephone or email reply.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Learn more about Adobe Technical Communication Suite (2015 Release) | http://bit.ly/1FR7zNW

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

Previous by Author: Writing for the company blog
Next by Author: RE: PPT training materials, pdf output (with inter pdf/ppt project hyperlinks) --what is the best tool?
Previous by Thread: Re: PPT training materials, pdf output (with inter pdf/ppt project hyperlinks) --what is the best tool?
Next by Thread: Re: Must documentation always follow the UI?


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads