Welcome to MSDN Blogs Sign in | Join | Help

Tech Writing (RSS)

Blog posts about my primary job function - technical writing.
Tuesday, August 05, 2008 11:07 AM

40+ Tips to Improve your Grammar and Punctuation

If you don't have your Strunk & White handy, this covers some of it. Purdue University maintains an online writing lab and I spent some time digging through it. Originally the goal was to grab some good tips that would help me out at work and on this
Posted by Rob Caron | 1 Comments
Wednesday, January 02, 2008 4:34 PM

More Team System User Education on Scenario Topics

Head over to the Team System User Education blog to get a look at a sample of what David Chesnut is calling scenario topics (from an earlier post: Team System User Education on Scenario Topics ), and be sure to give him some feedback with your thoughts.
Posted by Rob Caron | 1 Comments
Monday, June 25, 2007 5:27 PM

Team System User Education on Scenario Topics

Take a look at a proposal ( Visual Studio Team System User Education : Scenario Topics ) from David Chesnut of the Team System User Education Team that looks to replace the current orientation-style topics found in the product documentation with something
Posted by Rob Caron | 3 Comments
Friday, February 23, 2007 5:31 PM

No Writers Were Harmed in the Writing of Our Documentation

I was tickled to see that some Team System documentation made it on to The Daily WTF today (not SQL Server 2005 docs as noted in the post), and I'm happy to report that nobody was murdered while writing them. Susan (we don't have a Mark on the Team System
Posted by Rob Caron | 3 Comments
Tuesday, November 21, 2006 3:15 PM

J.D. Meier on Test-Driven Guidance

When J.D. Meier showed me early releases of Guidance Explorer , one of the things I found interesting was his developer mindset to apply test cases to content development. Today, he wrote up a post about it ( J.D. Meier's Blog : Test-Driven Guidance ).
Posted by Rob Caron | 0 Comments
Monday, October 09, 2006 11:20 AM

Guidance for Guidance Explorer

J.D. Meier posted some guidance on authoring prescriptive guidance modules for Guidance Explorer : How To Write Prescriptive Guidance Modules He also has a post that provides some general guidance on writing prescriptive guidance: Writing Prescriptive
Posted by Rob Caron | 0 Comments
Tuesday, August 29, 2006 11:31 AM

Sandcastle August CTP

You may recall a release in July of the first Sandcastle CTP ( Sandcastle - Documenting Managed Class Libraries ). A couple of days ago, we released an August CTP, which you can download here: Sandcastle August CTP Download . For a full list of new features,
Posted by Rob Caron | 0 Comments
Filed under:
Sunday, July 30, 2006 7:42 AM

Sandcastle - Documenting Managed Class Libraries

If you've always wanted to create MSDN-like documentation for your managed class libraries, you'll want to take a look at a project called Sandcastle . For an overview of this project, see Sandcastle Overview , which includes an attached PowerPoint presentation
Posted by Rob Caron | 5 Comments
Filed under: ,
Wednesday, July 05, 2006 11:46 PM

Creating a Documentation System Model

David Chesnut, a writer on the Team System User Education team who works on the docs for Team Foundation Server, wrote a post for the Team System User Education blog that applies principles from the Theory of Constraints to identify and understand the
Posted by Rob Caron | 0 Comments
Filed under: ,
Tuesday, May 23, 2006 3:41 PM

patterns & practices Guidance Explorer

Last week I paid a visit to J.D. Meier over in patterns & practices to take a look at Guidance Explorer , which is a relatively new project on GotDotNet. I've been relatively quiet these past few weeks, getting ready to release our patterns &
Posted by Rob Caron | 0 Comments
Monday, January 10, 2005 12:25 AM

Write about the 'here and now', or the 'soon to be'?

Last month, I wrote a post about Community Technology Previews (CTPs) and what I thought about them ( Team System Community Technology Previews (CTPs) ). On Friday, Josh Ledgard wrote an extensive post ( Adding to, but not Perverting the Beta Process
Posted by Rob Caron | 1 Comments
Filed under:
Tuesday, December 07, 2004 6:01 PM

Help Still Wanted: Two Programming Writers for Visual Studio Team System

My team (Visual Studio Team System User Education) now has TWO openings for a Programming Writer , which is a technical writer who writes reference and conceptual documentation for the developer audience. Here're the listings from the Microsoft Careers
Posted by Rob Caron | 2 Comments
Filed under:
Wednesday, November 17, 2004 10:36 AM

Betsy Aoki: On Writer's Guilt

My Text is not my own ...I am here to give you the real insider scoop on the secret agenda of technology. Disregard who invented the Internet. Ignore the man behind the curtain waving his arms wildly. The secret agenda of technology is to make writers
Posted by Rob Caron | 0 Comments
Filed under:
Wednesday, November 17, 2004 10:33 AM

Channel 9: Constanze Roman on Being a Programming Writer

Constanze Roman - Writing documentation for mobile devices Mike Hall took his camcorder over to the mobile devices team and met with Constanze Roman, a programming writer. They talk about what working as a documentation writer is like. Video length: 00:04:51
Posted by Rob Caron | 0 Comments
Filed under:
Saturday, November 13, 2004 12:56 PM

Write Less, Write Better

From: mike's web log Peter Cooper has some tips for reducing the size of your text by about two-thirds to substantially improve it and "make it shine." Apropo of our previous discussion of Strunk & White's The Elements of Style .
Posted by Rob Caron | 0 Comments
Filed under:
More Posts Next page »
 
Page view tracker