: Re: Standards for representing user interaction I am responsible for developing internal IT documentation but have only begun my scratching the surface on technical documentation. Is there a standard

A good resource for this is:

the Microsoft Manual of Style (the 4th edition is available via bookstores, older versions can be found on the internet as PDF or Winhelp file). @SF 's answer pretty much matches this style guide.

Whichever convention you end up using: document it. Add a section 'About this document' where you explain what your conventions mean.
Also, don't go overboard. A document that uses 10 different styles to indicate specific types of user interaction will just confuse the reader.
If you use a monospaced font, pretty much anything is better than Courier. I'm partial to the (open-source) Source Code Pro.

Load Full (0)

: I use the Gollum wiki. It works well for me. There's no database, just wiki-formatted text files. It uses the git version control system so you have a history of every change you make (and

@Ogunnowo420

Load Full 0 Comments

: How can I prepare for a career in instruction writing and editing? To technical background authors (e.g. Isaac Rabinovitch) who would possibly work in teams with non-technically trained writers:

@Ogunnowo420

Load Full 1 Comments

: How long on average does a major house 'consider' a book before rejecting or accepting it My first two fiction books are with a top publishing house. They have had them for three months. Six

@Ogunnowo420

Load Full 1 Comments

: Humor in a fantasy setting I'm creating a story based on the D&D Forgotten Realms campaign. Considering the main adversary in this case is a balor demon named Bob, an ally of the adventurers

: Re: Standards for representing user interaction I am responsible for developing internal IT documentation but have only begun my scratching the surface on technical documentation. Is there a standard

More posts by @Ogunnowo420

: I use the Gollum wiki. It works well for me. There's no database, just wiki-formatted text files. It uses the git version control system so you have a history of every change you make (and

: How can I prepare for a career in instruction writing and editing? To technical background authors (e.g. Isaac Rabinovitch) who would possibly work in teams with non-technically trained writers:

: How long on average does a major house 'consider' a book before rejecting or accepting it My first two fiction books are with a top publishing house. They have had them for three months. Six

: Humor in a fantasy setting I'm creating a story based on the D&D Forgotten Realms campaign. Considering the main adversary in this case is a balor demon named Bob, an ally of the adventurers

Login to post a comment!

0 Comments

Back to top