Question on documenting reports

Subject: Question on documenting reports
From: Joe Weinmunson <litlfrog -at- gmail -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Mon, 28 Sep 2020 10:05:48 -0400

The software I document currently has a Reports section in the Help file.
It goes through each report in the same order they appear in the menu,
explaining both why you would run such a report and the options available.
However, I am wondering if I should expand or replace this with more
task-based topics. A few reports are particularly versatile and get run all
the time for very different reasons. Example: instead of a single topic
about the Posting Report should I add topics like:
* getting a list of all payments made in a quarter;
* getting a list of all charges made by a given user;
* getting a list of all charges made for residential service.

How have others solved this dilemma?

--
Joe Weinmunson

âWhat you read when you donât have to determines what you will be when you
canât help it.â
--Oscar Wilde
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | https://techwhirl.com

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

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: RE: Usage of chemistry abbreviation for Normal (N)
Next by Author: Re: Usage of chemistry abbreviation for Normal (N)
Previous by Thread: Website Testers Sought
Next by Thread: RE: Question on documenting reports


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


Sponsored Ads