-
REST API Documentation
I recently had the opportunity to write a short (about 10 page) manual on a specific REST API for a client. I’m still trying to find some spare time to edit out any confidential info so I can post a PDF, but hope to get that done this week. REST API documentation is a growing area for technical writers. I’ve documented specifications before, and have documented software that used calls similar to REST to perform operations. But one thing struck me immediately about the sample docs I was finding online that were specifically REST API docs: they jump right in to tables of parameters. I saw almost zero text of…
-
Proposal Writing and RFP Monitoring
Seeing a posting for a “Proposal writer” job today made me realize I haven’t talked about one of my ongoing client projects. My client sells their two software products to city, county, and state governments, and came to me three years ago asking if I could provide them with some help in their RFP process. I currently do the following: Read daily RFP emails from state agencies and RFP aggregators. Monitor state databases of open RFPs for states that don’t send email updates. Identify opportunities to pursue. Review documents associated with the RFPs/RFIs, and summarize any issues or concerns. I’ve also started a database of potential partnership opportunities related to…
-
Working Remotely
An interesting blog post from May on Technical Communication and Urbanization caught my eye this morning. I lived in the heart of the Silicon Valley when I started as a tech writer, but moved to be closer to family. You couldn’t pay me enough to move back, or to move to one of the other cities known for tech writing jobs. It’s not the cost that’s keeping me away (although that would be enough on its own). It’s the lifestyle. Here in Salem I’m just over an hour from the coast. I’m a short drive from three of my favorite wineries, and can easily drive a little further to find…
You May Also Like
Re-writing and Updating
Proposal Writing and RFP Monitoring
REST API Documentation
-
Tech Writing Trends
An interesting overview of trends in Technical Documentation for 2018. I’d Rather Be Writing.
-
Finding Your Voice
A good article on finding your “voice” in your written communication. PR Daily.
-
Re-writing and Updating
Working on re-writing and updating three manuals for Gov. users in Pennsylvania this week. I now know a lot about how fingerprint-based background checks are processed by the software (and by the users of the software) in PA. The more manuals I write the better my chances of someday winning on Jeopardy.
-
Technical Documentation and Crowdsourcing
Extremely interesting post on the I’d Rather Be Writing website about crowdsourcing documentation. My major takeaway is this: “It takes more of a sense of expertise and authoritativeness to write documentation than to answer a forum question.” I agree completely. I also agree with his premise that our jobs aren’t going away any time soon because of that. Read more: http://idratherbewriting.com/2017/08/05/why-stack-overflow-documentation-effort-failed/
Technical & Content Writing
