You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _posts/articles/2017-11-12-rackspace-case-study.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -103,7 +103,7 @@ At the same conference, [Rachel Whitton’s talk Delivering High-Velocity Docs t
103
103
104
104
Finally, another great resource is Anne Gentle’s [Docs like Code project](https://docslikecode.com/) that aims to share information and capture best practices for creating documentation collaboratively using code systems.
105
105
106
-
Are you treating docs like code, or thinking about transforming your documentation processes? We’d love to hear your thoughts and experiences. If you have questions or want to know more about contributing to Rackspace documentation, see our [Contributor Guidelines](https://rackerlabs.github.io/docs-rackspace/contributor-collateral/index.html) or e-mail us at devdoc@rackspace.com.
106
+
Are you treating docs like code, or thinking about transforming your documentation processes? We’d love to hear your thoughts and experiences. If you have questions or want to know more about contributing to Rackspace documentation, see our [Quickstart](https://docs.rackspace.com/docs/style-guide/quickstart) or e-mail us at devdoc@rackspace.com.
107
107
108
108
Originally published November 11, 2016, on the [Rackspace Blog](https://blog.rackspace.com/transforming-developer-and-support-documentation-with-docs-like-code).
Copy file name to clipboardExpand all lines: _posts/articles/2018-02-12-change-case-study.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ comments: false
13
13
share: true
14
14
---
15
15
16
-
**Originally published in the [Documenting APIs: A Guide for Technical Writers on Tom Johnson's site, I'd Rather Be Writing](https://idratherbewriting.com/learnapidoc/pubapis_switching_to_docs_as_code.html). Thanks, Tom, for sharing your story in detail for others to learn.**
16
+
**Originally published in the [Documenting APIs: A Guide for Technical Writers on Tom Johnson's site, I'd Rather Be Writing](https://idratherbewriting.com/learnapidoc/pubapis_docs_as_code.html). Thanks, Tom, for sharing your story in detail for others to learn.**
17
17
18
18
{: .tip}
19
19
For an overview of the docs-as-code approach, see [Docs-as-code tools](https://idratherbewriting.com/learnapidoc/pubapis_docs_as_code.html). In this article, I describe the challenges we faced in implementing a docs-as-code approach within a tech writing group at a large company.
@@ -89,7 +89,7 @@ Based on the Content Inventory and the results of the Card Sorting sessions, we
89
89
90
90
_Sample page from our sitemap_
91
91
92
-
We have already changed some parts of our sitemap based on new information we gathered and business decisions we made. For example, we are now planning to build a separate community site, instead of having a community section on our documentation site. We decided to link to content on [platform-os.com](https://www.platform-os.com/blog/post/blog/platform-os-blog-module) (like the blog, terms & conditions, etc.) in the beginning to focus on other parts of the site, and reevaluate these sections later. We believe that both product and content development can benefit from a process that allows for such flexibility.
92
+
We have already changed some parts of our sitemap based on new information we gathered and business decisions we made. For example, we are now planning to build a separate community site, instead of having a community section on our documentation site. We decided to link to content on [platform-os.com](https://www.platform-os.com/blog/post/platform-os-blog-module) (like the blog, terms & conditions, etc.) in the beginning to focus on other parts of the site, and reevaluate these sections later. We believe that both product and content development can benefit from a process that allows for such flexibility.
93
93
94
94
### Persona-based content prioritization
95
95
@@ -109,6 +109,6 @@ This concluded our Information Architecture phase. We have discovered and organi
109
109
110
110
_We involved [UX Strategist Katalin Nagygyörgy](https://www.linkedin.com/in/nagygyorgykatalin/) in our process from the start. Through our collaboration, we could extract and collect all the necessary information using tried and true research methodologies and UX best practices._
111
111
112
-
_This article was originally written for the [platformOS Blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platformos-part-1-information-architecture)._
112
+
_This article was originally written for the [platformOS Blog](https://www.platform-os.com/blog/post/building-our-documentation-site-on-platformos-part-1-information-architecture)._
@@ -142,6 +142,6 @@ We hope you enjoyed learning about how we started content production, how we bui
142
142
143
143
_We involved [UX Strategist Katalin Nagygyörgy](https://www.linkedin.com/in/nagygyorgykatalin/) in our process from the start. Through our collaboration, we could extract and collect all the necessary information using tried and true research methodologies and UX best practices._
144
144
145
-
_This article was originally written for the [platformOS Blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platformos-part-2-content-production-and-layouts)._
145
+
_This article was originally written for the [platformOS Blog](https://www.platform-os.com/blog/post/building-our-documentation-site-on-platformos-part-2-content-production-and-layouts)._
@@ -112,6 +112,6 @@ Now that you’ve seen how we discovered the needs of our target audience, plann
112
112
113
113
_We involved [UX Strategist Katalin Nagygyörgy](https://www.linkedin.com/in/nagygyorgykatalin/) in our process from the start. Through our collaboration, we could extract and collect all the necessary information using tried and true research methodologies and UX best practices._
114
114
115
-
_This article was originally written for the [platformOS Blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platformos-part-3-community)._
115
+
_This article was originally written for the [platformOS Blog](https://www.platform-os.com/blog/post/building-our-documentation-site-on-platformos-part-3-community)._
In this article series we describe the process of building our [award-winning](https://www.platformos.com/blog/post/blog/platformos-developer-portal-wins-uk-technical-communication-award) developer documentation site from discovery to development, with in-depth insights into our approach, decisions, plans, and technical implementation.
16
+
In this article series we describe the process of building our [award-winning](https://www.platformos.com/blog/post/platformos-developer-portal-wins-uk-technical-communication-award) developer documentation site from discovery to development, with in-depth insights into our approach, decisions, plans, and technical implementation.
17
17
18
18
*[Part 1: Information Architecture](/articles/platformos-1of4)
19
19
*[Part 2: Content Production and Layouts](/articles/platformos-2of4)
@@ -132,14 +132,14 @@ In the near future, we are planning to implement **performance testing with real
132
132
133
133
If you’d be interested in learning more about our process and tools, check out our article series on QA and testing:
134
134
135
-
*[QA and Testing Best Practices — Part 1: Our QA Process](https://www.platformos.com/blog/post/blog/qa-and-testing-best-practices-part-1-our-qa-process)
136
-
*[QA and Testing Best Practices — Part 2: Tips and Tricks](https://www.platformos.com/blog/post/blog/qa-and-testing-best-practices-part-2-tips-and-tricks)
137
-
*[QA and Testing Best Practices — Part 3: Speeding Up Development and Troubleshooting](https://www.platformos.com/blog/post/blog/qa-and-testing-best-practices-part-3-speeding-up-development-and-troubleshooting)
138
-
*[QA and Testing Best Practices — Part 4: Performance Testing](https://www.platformos.com/blog/post/blog/qa-and-testing-best-practices-part-4-performance-testing)
135
+
*[QA and Testing Best Practices — Part 1: Our QA Process](https://www.platformos.com/blog/post/qa-and-testing-best-practices-part-1-our-qa-process)
136
+
*[QA and Testing Best Practices — Part 2: Tips and Tricks](https://www.platformos.com/blog/post/qa-and-testing-best-practices-part-2-tips-and-tricks)
137
+
*[QA and Testing Best Practices — Part 3: Speeding Up Development and Troubleshooting](https://www.platformos.com/blog/post/qa-and-testing-best-practices-part-3-speeding-up-development-and-troubleshooting)
138
+
*[QA and Testing Best Practices — Part 4: Performance Testing](https://www.platformos.com/blog/post/qa-and-testing-best-practices-part-4-performance-testing)
139
139
140
140
## Performance
141
141
142
-
If you read our article about [Code Quality and Performance Best Practices for Your platformOS Site](https://www.platformos.com/blog/post/blog/code-quality-and-performance-best-practices-for-your-platformos-site), you know how good performance can help you keep visitors on your site, provide the best user experience, and rank high in search results. Our documentation is a high-performance site with a Google PageSpeed Insights score of 100 for both Mobile and Desktop, so we thought it could be helpful to dive a bit deeper into what tools we use and how we achieved this amazing performance.
142
+
If you read our article about [Code Quality and Performance Best Practices for Your platformOS Site](https://www.platformos.com/blog/post/code-quality-and-performance-best-practices-for-your-platformos-site), you know how good performance can help you keep visitors on your site, provide the best user experience, and rank high in search results. Our documentation is a high-performance site with a Google PageSpeed Insights score of 100 for both Mobile and Desktop, so we thought it could be helpful to dive a bit deeper into what tools we use and how we achieved this amazing performance.
143
143
144
144
### Measure early, measure often
145
145
@@ -256,7 +256,7 @@ We collect user feedback through Slack channels, the feedback block, user resear
256
256
257
257
We’ve come a long way but there’s still a lot we can improve. Stay tuned, because we will write more articles to support you on your journey with platformOS.
258
258
259
-
_This article was co-authored by Pawel Kowalski, Front-End Developer and Performance Advocate at platformOS, and was originally written for the [PlatformOS Blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platformos-part-2-content-production-and-layouts)._
259
+
_This article was co-authored by Pawel Kowalski, Front-End Developer and Performance Advocate at platformOS, and was originally written for the [PlatformOS Blog](https://www.platform-os.com/blog/post/building-our-documentation-site-on-platformos-part-2-content-production-and-layouts)._
Copy file name to clipboardExpand all lines: _posts/articles/2021-02-14-setting-up-techdocs-on-backstage.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -214,7 +214,7 @@ You will also see the content in the S3 bucket.
214
214
215
215
## Recap and summary
216
216
217
-
In summary, we went through an introduction on Backstage, TechDocs, and how to publish TechDocs locally. We took a look at the cloud storage option with some screenshots showing S3. To learn more about Backstage I would recommend visiting [https://backstage.io](https://backstage.io) or if you want to learn more about TechDocs then [https://backstage.io/docs/features/TechDocs/TechDocs-overview](https://backstage.io/docs/features/TechDocs/TechDocs-overview) offers a great overview.
217
+
In summary, we went through an introduction on Backstage, TechDocs, and how to publish TechDocs locally. We took a look at the cloud storage option with some screenshots showing S3. To learn more about Backstage I would recommend visiting [https://backstage.io](https://backstage.io) or if you want to learn more about TechDocs then [https://backstage.io/docs/features/techdocs/techdocs-overview](https://backstage.io/docs/features/techdocs/techdocs-overview) offers a great overview.
218
218
219
219
You can also read about the gains the team at Spotify has seen since using TechDocs for all their documentation in [Ten tips for maintaining a long-term relationship with docs like code](https://www.docslikecode.com/articles/ten-tips-maintaining-long-term-docs-like-code/). TechDocs has a really nice [project board in GitHub,](https://github.com/orgs/backstage/projects/1#card-54927264) so if you're interested in working on it yourself, take a look.
0 commit comments