CHI-WEB Archives

ACM SIGCHI WWW Human Factors (Open Discussion)

CHI-WEB@LISTSERV.ACM.ORG

Options: Use Forum View

Use Monospaced Font
Show Text Part by Default
Condense Mail Headers

Message: [<< First] [< Prev] [Next >] [Last >>]
Topic: [<< First] [< Prev] [Next >] [Last >>]
Author: [<< First] [< Prev] [Next >] [Last >>]

Print Reply
Sender:
"ACM SIGCHI WWW Human Factors (Open Discussion)" <[log in to unmask]>
X-To:
Date:
Tue, 2 Dec 2008 09:21:57 +0100
Reply-To:
Mathijs Panhuijsen <[log in to unmask]>
Subject:
From:
Mathijs Panhuijsen <[log in to unmask]>
Content-Transfer-Encoding:
quoted-printable
In-Reply-To:
A<20081118013927.LZ4EK.52338.root@hrndva-web18-z01>
Content-Type:
text/plain; charset="UTF-8"
MIME-Version:
1.0
Parts/Attachments:
text/plain (68 lines)
It is online, though possibly in an old version. Check this link, for example.
http://faculty.washington.edu/farkas/TC407/MSTP-V3.pdf

I'm a tech writer, and I find it a very helpful document that is surprisingly thorough, especially if you're documenting Windows interfaces.

Their choice to use the term 'option buttons' for 'radiobuttons', though, while understandable, never really caught on, I think.
There are some other cases where you might question their choice of term.
But in the end, in documentaiton, consistency is much more important than the agreed-upon word.

Regards,
Mathijs



-----Original Message-----
From: ACM SIGCHI WWW Human Factors (Open Discussion) [mailto:[log in to unmask]] On Behalf Of [log in to unmask]
Sent: Tuesday, November 18, 2008 02:39
To: [log in to unmask]
Subject: Re: Technical Writing for Interface User Guides

Keith,

I don't think it's online, but I would suggest the Microsoft Manual of Style for Technical Publications. I have used it for years to ensure writing teams use consistent language when describing user interfaces.

Mike 
---- Keith Dvorak <[log in to unmask]> wrote: 
> I'm wondering if anyone knows of an online resource for technical writing
> for interfaces. I am not really looking for things like when to use bullets
> v numbering, or bold, or italics (though I'm not opposed to that
> information per se). What I want is something that discusses whether to use
> "click" or "type" or "press," use "select" for check boxes (or don't use
> "select"). Is it an "arrow" or "drop-down" arrow, and do I "choose,"
> "click," or "select the options presented?
> 
> Thank you for any information you can provide!
> 
> Here's to the weekend!
> 
> Keith
> 
> Fabricando fabri fimus
>     --------------------------------------------------------------
>     Tip of the Day: Suspend your subscription if using auto replies
>      CHI-WEB: www.sigchi.org/web POSTINGS: mailto:[log in to unmask]
>               MODERATORS: mailto:[log in to unmask]
>        SUBSCRIPTION CHANGES & FAQ:  www.sigchi.org/web/faq.html
>     --------------------------------------------------------------
> 

    --------------------------------------------------------------
           Tip of the Day: Postings must be in plain text
     CHI-WEB: www.sigchi.org/web POSTINGS: mailto:[log in to unmask]
              MODERATORS: mailto:[log in to unmask]
       SUBSCRIPTION CHANGES & FAQ:  www.sigchi.org/web/faq.html
    --------------------------------------------------------------




The contents of this email and any attachments thereto are confidential to the intended recipient(s). They may not be disclosed to, used by or copied in any way by anyone other than the named addressee(s). If you have received this email by mistake, please notify SDL Tridion immediately on +31 (0)20 20 10 500 quoting the name of the sender and the email address to which it has been sent and then delete it from your system. SDL Tridion does not accept liability for any errors or omissions in the contents of this message, which arise as a result of email transmission, nor does SDL Tridion accept liability for any damage caused by any virus transmitted by this email.

    --------------------------------------------------------------
    Tip of the Day: Suspend your subscription if using auto replies
     CHI-WEB: www.sigchi.org/web POSTINGS: mailto:[log in to unmask]
              MODERATORS: mailto:[log in to unmask]
       SUBSCRIPTION CHANGES & FAQ:  www.sigchi.org/web/faq.html
    --------------------------------------------------------------

ATOM RSS1 RSS2