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
0 votes
2 answers
35 views

Is it a good idea to use Git for document management of technical documentation?

I have compiled the technical documentation for a physical product. It includes documents like user manuals, technical descriptions, maintenance instructions, etc. I have decided that all these ...
Dave's user avatar
  • 1
0 votes
2 answers
98 views

Database documentation verb choice: If "fieldname" has/contains/is/displays

I'm trying to find the right verb for database documentation. I have to write a lot of these and it is very long; so I am working for a consistent and reusable way to phrase this. What I have now: ...
Pierce Devol's user avatar
15 votes
2 answers
998 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 ...
Pierce Devol's user avatar
1 vote
2 answers
128 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?
SomeBloke's user avatar
  • 113
9 votes
3 answers
1k 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 ...
Liquid's user avatar
  • 15.9k