Questions tagged [training-materials]

This tag should be used for questions in the context of technical writing where you are creating a documentation that is intended to be used by people who are new to a system so that they can be trained with the documentation to use the system.

This tag should be used for questions in the context of where you are creating a documentation that is intended to be used by people who are new to a system so that they can be trained with the documentation to use the system.

You should mention which restrictions apply, such as restrictions about the that can be used or the that has to be preserved, and you should mention what problem you have with writing the training material, such as whether you are asking about the length, structure or of the document.

3 questions
25
votes
9 answers

Should beta functionality be mentioned in a training manual?

I write training manuals for a software product. When that product is next released one of the tools in it will be marked "in beta". i.e. that functionality is is included only as a technical preview. Product documentation will surely include that…
Mark Ireland
14
votes
6 answers

When is a screenshot really useful in training documentation?

Software products evolve more rapidly each day. Technical documentation for those products must also follow their evolution. One of the biggest challenges is to maintain screenshots when the graphical user interface (GUI) changes. An easy way to…
Fuhrmanator
  • 245
  • 2
  • 8
0
votes
2 answers

Technical Documentation and Training System Utilizing Markdown and Live Updates

This may not be the correct place to post this question, but I'm at a loss of where else it can go. I'm attempting to research a potential documentation system for my company to use that would replace our current system for storing, publishing,…