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 site, but there is simply too much…

1

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. Sample Help File for Scenario Topics If you have…

1

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 a bit more useful. As always, your feedback is crucial and greatly appreciated. To me,…

3

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 doc team) fixed the error and we’ll have the…

3

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). If you’re an author or a reviewer, this technique may help you.  You…


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 Guidelines For those who don’t know him, J.D. has been the program manager (PM) for security and performance on the patterns &…


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, and a list of bug fixes, see: Sandcastle August CTP Release…


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 about it. The first CTP is now available (Announcing Sandcastle CTP) and you can find instructions…

5

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 bottlenecks in our current documentation workflow. Over the last few months I’ve…


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 & practices Guidance Explorer. Guidance Explorer is a new, experimental tool from…