Dave Donaldson
Critical thinking in software development
Search
Advertisement
Subscribe
Technorati
View blog authorityView blog reactions
My Tweets
- TortoiseSVN forcing reboots sucks.
- Blogged: Blog Images Fixed arcware.net/.../blog-images-fix
- "Brian, I'm ready. You in or out?" LOL.
- Follow Me on Twitter
Microsoft Manual of Style for Technical Publications
Wednesday, March 26 2008
Back when I posted about UserName or Username?, my friend Jennifer left a comment about a book named Microsoft Manual of Style for Technical Publications. I'd never heard of it, but if you knew Jennifer you'd know that it's *not* surprising she knew about it.
Anyway, I've been doing lots of API work lately (as usual) and figured it might be good to have some sort of reference on hand for stuff like UserName or Username and was thinking of picking up this book. It's got pretty good reviews; does anyone out there have it? Is it worth picking up?
4 comment(s) so far
Dave, I picked up a copy of this book a few years ago...geesh, must have been late 90s I think. It's a good book, and in the whole scheme of things, it's only $20, right?
I can't speak to the book in question, but for API design guidelines (including naming conventions), I'd look at picking up a copy of Framework Design Guidelined by Krzysztof Cwalina and Brad Abrams (if you don't have it yet) before a technical writing book. It's fantastic.
http://www.amazon.com/Framework-Design-Guidelines-Conventions-Development/dp/0321246756/
(Version 2 will be out in September)
And to answer this question, page 40 suggests that it should be UserName, and specifically not Username. :-) Personally, I tend to go with Username regardless because UserName just doesn't sit well with me.
Xander - Yep, the Framework Design Guidelines book is one of my favorites and I'm really looking forward to the 2nd edition. But I think a technical writing book could be a useful companion.
And as much as I love the Framework Design Guidelines book, I think most agree it has the UserName usage wrong.
dave, this book i believe was internally developed at msoft to guide their own internal publications...it's the only book in my opinion that gives guidance and standards on what items are called what in the user interface.