Humanitec
A Platform Engineers best friend!
Humanitec is an easy-to-use solution for building Internal Developer Platforms
Summary
Humanitec’s documentation was developer-written as time allowed. It lacked a consistent voice and quality.
Using my experience as a professional writer and lead engineer, they asked that I refine their content and create a consistent documentation style that targeted the way their core audience preferred to consume information.
With my co-writer Patrick, we created developer.humanitec.com, initially styled after Hashicorp’s equivalent site, and then refined to a simpler structure.
This involved a complete rewrite of almost every section to ensure that it was both up-to-date and consistent in the language, style, and structure.
How it was built
Patrick and I started by becoming experts in using Humanitec, we went through every piece of training available and built several IDPs using it.
With this foundation of knowledge, we began replacing and refining the existing content of the old “docs” site, ensuring that the content there was up-to-date, accurate, and of consistent quality. Once we were happy that the docs site met users’ immediate needs, we began work on the developers’ site.
The developer’s site was brought to life with assistance from across the team, with input and analysis directly from Kaspar (CEO, Humanitec). Everything, from the ideal user journey to the dissemination of knowledge and information throughout the customers’ teams, were considered and planned for.