The technical writing portfolio of Kayce Basques.
This is a comprehensive, roughly chronological list of everything I've created as a technical writer.
Note: I was the sole author on the latest iteration of these documents. If you see 2 or more authors, it means I based the content off of earlier work that other people had created.
Quantified Code was a Berlin-based startup. Their main product was an automated code analysis tool for Python codebases. I wrote over 100 guides for their companion site, The Little Book Of Python Anti-Patterns. The purpose of the companion site was to share their knowledge of Python best practices while also driving traffic to their automated product. E.g. their sales pitch was "rather than trying to remember all of these best practices, we have an automated tool that can do it for you." Subject matter experts at Quantified Code gave me a list of topics to write about. If I recall correctly, each topic only had a one-line description. I researched and drafted each guide myself. The subject matter experts reviewed my guides.
Note that the list below is not complete. It looks like some of the guides were deleted over time. See my commit history for the full list of contributions.
Arrayent was an internet of things startup. I was the sole technical writer in the company. This was my first full-time technical writing job. I wrote developer documentation for an embedded API as well as a REST API, in addition to end-user documentation for a couple of web applications. I even hacked together a custom XSLT stylesheet to convert our Doxygen-generated reference documentation to more reasonable HTML. I also migrated the company's documentation from Microsoft Word to a website. I used Sphinx to generate the site and stored the source code on BitBucket. I deployed the site to Heroku. I don't think I set up an automated deployment system because running the command to deploy to Heroku was trivial. In addition to managing all of our customer-facing documentation I also managed our SDKs, which we sent out to prospective customers.
Embedded Developer Docs:
Web Developer Docs:
Web App User Docs: