Tag Archives: guidelines
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, […]
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 […]
Goethe once wrote to a friend, “If I had more time, I’d have sent you a shorter letter.” Here’s why.