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.

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

If this is in the context of you should mention any restrictions that may apply, such as restrictions on the that can be used or the that needs to be preserved.

3 questions
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 the user to say chapter 2 sectionXY23 to perform…
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 would like to have - an easy-to-use interface for…
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 graphics. The affected graphics are not necesarily…
Monica Cellio
  • 21,489
  • 3
  • 68
  • 110