Here you will find samples of a few different sorts of industry tech docs I have written in the past. They are all in Markdown format (*.md), and so you can simply click on the Markdown file to render on GitHub. Some are from different product teams I worked on, some are for personal software I developed like DoDate, some are from previous employment - such as the AWS Verified access docs - and some are just examples.
-
Kubernetes101: A beginner's guide to Kubernetes with a conceptual introduction and a hands-on tutorial using Google Cloud to deploy and test Kuberntes with a simple application.
-
AVA_CEDAR: Technical explainer on how to approach using Cedar policy language with AWS Verified Access service.
-
Rest vs SOAP APIs: a conceptual piece pointing out the difference between REST and SOAP protocol and APIs.
-
API Docs Example: an example of a an fleshed out API docs example for a little bitcoin API I found on Mashape in both PDF and MD.
-
DoDate: The technical Readme from a ToDo application I coded in React and Ruby Rails with React Drag and Drop implemented.
-
AVA_tutorial: A hands-on tutorial showing how to setup an AWS Verified Access Instance so that it is ready for policy.