Questions tagged [maintenance]

This tag should be used for questions about writing technical documentation, such as software documentation, that is intended to be used for the maintenance of a system.

Filter by
Sorted by
Tagged with
8 votes
4 answers

Is it better to repeat steps listed elsewhere in a manual, or to refer the reader to where the steps are listed elsewhere in the manual?

We have a tool that we cannot replace that does not support single sourcing. As a result, with instructions that involve the same node, we either repeat the same dozen steps over and over, or refer ...
Lefty G Balogh's user avatar
8 votes
3 answers

Best Tool to Create User Guides

We are planning to create a user guide for internal use only. It's 150-page document in Word for a self-developed SW tool. The user guide will require constant update. No translation is needed. We ...
xifeng's user avatar
  • 81
6 votes
4 answers

How can I manage screen shots and other graphics for maintenance?

Our ~1500-page documentation set contains numerous screen shots and related graphics (schematics, flow diagrams, etc). Sometimes the user interface changes and we have to update all the affected ...
Monica Cellio's user avatar