Looking for examples of API documentation online? Wondering how the big boys write their API documentation so you can get a little inspiration? Me too. //Get the REST API Documentation Tutorial here We’ve being writing a lot of API documents recently for a new client. She asked for examples of how other IT companies publish […]
Want to document your Web and RESTful APIs but don’t know where to start? Me too. APIs are great but they also need documentation. I did a bit of hunting and compiled this list. It’s in no particular order of preference. I sorted them A-Z. [Get the API Documentation Template here] 21 API Documentation Tools […]
Is there anything worse than writing User Guides all afternoon and then… Word crashes! If your Microsoft Word files suddenly become huge and start crashing, here’s a few ways to fix it. I’ve creating some very long technical documents in Microsoft Word and learnt a few ways to control these documents.
What can Kate Winslet teach you about proof-reading technical documents? Watch the movie The Reader and it will make sense. If she was writing this blog, she’d probably say: “Don’t do it all at once! One of the biggest mistakes you can make when revising any technical document, is to do it all in one […]