There are tasks you never know when you are done with. Documenting a complex API is one of those. I spent the last 6 weeks working on PostSharp 2.0 documentation, and it seems like I could spend another month on it. Yet, I think the result is already better than good enough – it’s actually pretty good. It’s available online here:

http://doc.sharpcrafters.com/

Note that the documentation refers to the last hot fix (1266+). Some features or APIs may not be available in the last CTP.

Inside the Book

The documentation is structured in two principal parts: deploying PostSharp, and developing with aspects.

The first part starts where the setup program stops: development environment may be very complex; deploying development tools to a large team may be very challenging. This chapter is based on my experience of supporting customers during last months. Special thanks go to Roy Osherove of TypeMock, who patiently went through all imaginable problems. His feedback prompted me to make deployment easier and to seriously document it. Thanks to all folks who reported issues or simply questions on the forum.

The second part is about aspect-oriented development itself. If you thought you knew everything about PostSharp, read this chapter. This is where you can contemplate the robustness and consistency of PostSharp 2.0 design. It’s elegant. Intelligent. Well-crafted. I’m proud of it.

Credits

Apart from Roy mentioned above, I would like to express my gratitude to two projects and the guys behind:

  • Eric Woodruff’s Sandcastle Help File Builder (SHFB) is wonderful. I deleted my 4-years old Sandcastle custom build scripts and switched to SHFB in a couple of hours. Writing content in MAML rocks. Thank you Eric for this excellent work!
  • Help Server of X-tensive.com is a superb product. You can judge by yourself on http://doc.sharpcrafters.com/. It’s a commercial product, but it’s definitively worth the money. Thank you Alex and team!

What’s next?

The documentation was the last big task to complete before the release. The rate of bug reports has dramatically decreased since the last CTP. So you can expect the RC very soon, hopefully next week.

Note: If you are still using PostSharp 1.5 and are not registered yet on our web site, do it now. Once PostSharp 2.0 will be RTWed, PostSharp 1.5 won’t be available any more for new users.

Happy PostSharping!

-gael

Pingbacks and trackbacks (2)+

Comments are closed