GOOD NEWS: The open source version of TechDocs is out now. This video demos Spotify’s internal version, which has custom features built-in. With the open source version now available, TechDocs is ready for special features of your own. Read how to get started and learn more about our “docs like code” approach here:
[ Ссылка ]

---

Technical documentation! Everyone needs it, no one wants to create it, and no one can ever find it. When we conducted productivity surveys at Spotify in years past, our engineers named the “inability to discover technical information” as the number three problem they faced — and they had some other not-so-nice things to say about our existing documentation, too (“hard to find”, “spread out”, “outdated”, “relies on knowing who to ask”). So, yeah. We knew it was time for us to get serious about documentation.

First, we embraced the philosophy known as “docs like code”. It’s where you write documentation using the same workflow as you write your code. Backstage made this easy for us. Whenever you create a new software component in Backstage, you also get a Markdown-based, static HTML site for your documentation, for free.

We call these sites TechDocs. They live right inside your project’s repo, are accessible to everyone on Backstage, and feature a standardized UI. Our internal version also includes some pretty slick integrations with GitHub Enterprise and Stack Overflow Enterprise, are fully searchable, and link directly to owners and Slack channels for support. (We hope to see these features added to the open source version of TechDocs, too.) All of which leads to documentation that’s easier to create, maintain, find — and, you know, actually use.

Watch the video for a quick tour of how Spotify does documentation in Backstage with our internal version of TechDocs:

0:00 The problem with documentation
0:24 Our approach: “docs like code”
1:20 Special features in Spotify’s internal version of TechDocs

Then help us build the open version of TechDocs — the first iteration is live now and ready to go.

---

Learn more about Backstage — the open platform for building developer portals that reduces infrastructure chaos😤 and increases developer happiness🥰: [ Ссылка ]

🛠 For features, demos, and docs: [ Ссылка ]

🚀 For help on how to get started: [ Ссылка ]

✉️ Subscribe to the newsletter for product updates, community news, and more: [ Ссылка ]

👩🏻‍💻 Join the community at: [ Ссылка ]

свернуть