You know in Star Trek, when they’re looking into the Captain’s Log? I bet they also had an Error Message log for when things went real bad. You know, like when the Klingons actually won and took over the Enterprise. Ok, so what’s this got to do with tech docs? Well, it’s a roundabout way […]
C# Namespace Guidelines
March 7, 2015 by
Let’s create some guidelines for documenting .Net Namespace. For example, let’s look at the System.Collections Namespace. What do we notice? Namespace – define the namespace using the following convention: System.Collections Namespace Purpose – describe the purpose of the namespace, for example: The System.Collections namespace contains interfaces and classes that define various collections of objects, […]
How To Write Technical Documentation For APIs
February 1, 2010 by
One of the threads on LinkedIn is how to write technical documentation for APIs. It’s been many years since I’ve documented an API (Java & Oracle) so if you have any thoughts on the best way to do this, then please jump in. An application programming interface (API) is an interface implemented by a software […]
Detox your Technical Documents; put your Words on a Diet
October 24, 2009 by
Goethe once wrote to a friend, “If I had more time, I’d have sent you a shorter letter.” Here’s why.