CSS for Technologists
- I designed a CSS for technical documentation last weekend. It's called Backslash.
- Last Saturday, I was writing some documentation for an API and wondered: what's the best visual language and format to explain code?
- Documentation is one of the most important parts of software engineering. Yet, I can only think of ReadMe and GitBook as doing something interesting in that space. Who else is innovating?
- The innovation comes from individuals and companies designing their own docs, like
Stripe. Stripe has done an excellent job at visualizing snippets of code on a page. For a developer, a clear line of code is worth a thousand words.
- The goal of Backslash is to map the elements of a text document to the visual characteristics of a code editor.
- I put it all on one page to see what it would look like. It's the first draft. What do you think? If you'd like to use Backslash, ping me. If you'd like to see how it evolves, follow me or subscribe below for updates.
- Made in Cambridge, MA. Generated with Ivy. Styled with Backslash. All emojis designed by OpenMoji – the open-source emoji and icon project. License: CC BY-SA 4.0