Questions tagged [documentation]

Questions regarding the writing of any kind of technical documentation. For software-documentation and api-documentation related questions, see the aforementioned tags.

Filter by
Sorted by
Tagged with
15
votes
2answers
968 views

Preferred word for “preferred”, “target”, “chosen” in end user support documentation

I'm having trouble finding and sticking to one word to indicate whatever value the user intends to use with my instructions. For example: Select your preferred printer. I'm wondering what ...
1
vote
2answers
72 views

What are the recommended sizes for a text box?

If I am making a text box for an online document, how many characters should I leave for things like names and dates?
7
votes
3answers
148 views

How to include external references when writing internal documentation?

In the IT industry, we often write a lot of technical documentation meant for internal use only. Those documents are often stored in an internal wiki and accessed when the need arises. The content ...