Skip to content

Commit e4955ec

Browse files
committed
Edits for the lead in and move the Spotify description
1 parent 1defa02 commit e4955ec

1 file changed

Lines changed: 5 additions & 7 deletions

File tree

_posts/articles/2020-11-06-ten-tips-maintaining-long-term-docs-like-code.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,21 @@ comments: false
1313
share: true
1414
---
1515

16-
<!-- By Gary Niemen, Product Manager for TechDocs, Spotify’s docs-like-code solution -->
17-
18-
I remember about two years ago sitting here watching a Write the Docs video. Well, not precisely “here” because we sat in offices in those days and in 2020 I'm in my home office working for Spotify. If you haven't heard of it, Spotify is a digital music, podcast, and video streaming service providing access to content from artists around the world. I was watching, wide-eyed and a bit confused, a video of [Riona MacNamara’s talk from Write the Docs 2015](https://youtu.be/EnB8GtPuauw). In the talk, Riona described how she and another technical writer used a docs-like-code approach to change Google engineering culture around technical documentation.
16+
I remember about two years ago sitting here watching a Write the Docs video. Well, not precisely “here” because we sat in offices in those days and in 2020 I'm in my home office. I was watching, wide-eyed and a bit confused, a video of [Riona MacNamara’s talk from Write the Docs 2015](https://youtu.be/EnB8GtPuauw). In the talk, Riona described how she and another technical writer used a docs-like-code approach to change Google engineering culture around technical documentation.
1917

2018
I remember seeing this adoption curve and saying to myself: We need to do this. I want that curve.
2119

22-
![image](/images/spotify/adoption1.png)
20+
![running total: projects & authors from Documentation, Disrupted ](/images/spotify/adoption1.png)
2321

2422
And just a few months later, we had built and released TechDocs, Spotify’s docs-like-code solution for internal technical documentation. And a few months after that, we had the curve that I had longed for. Nice gradient, eh?
2523

26-
![image](/images/spotify/adoption2.png)
24+
![Adoption Stats](/images/spotify/adoption2.png)
2725

28-
We were fortunate in that there were several synchronous moments that helped us, but overall, we moved fast because we were able to make use of preexisting infrastructure, such as [Backstage](https://backstage.io/) (our homegrown and now open sourced developer portal) and Tingle, Spotify’s CI/CD tool. We also made use of the open source static site generator, [MkDocs](https://www.mkdocs.org/).
26+
If you haven't heard of it, Spotify is a digital music, podcast, and video streaming service providing access to content from artists around the world. We were fortunate in that there were several synchronous moments that helped us, but overall, we moved fast because we were able to make use of preexisting infrastructure, such as [Backstage](https://backstage.io/) (our homegrown and now open sourced developer portal) and Tingle, Spotify’s CI/CD tool. We also made use of the open source static site generator, [MkDocs](https://www.mkdocs.org/).
2927

3028
In just two short years, writing docs in Markdown in our enterprise version of GitHub has become standard practice. We have over 3,000 doc sites from across the organisation, all showing up and searchable in Backstage. And most of the feedback we get from engineers is positive with the odd request for a small tweak or improvement.
3129

32-
![image](/images/spotify/techdocs.png)
30+
![TechDocs Documentation screenshot](/images/spotify/techdocs.png)
3331

3432
Time to put our feet up, right?
3533

0 commit comments

Comments
 (0)