Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _posts/articles/2017-11-12-rackspace-case-study.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ At the same conference, [Rachel Whitton’s talk Delivering High-Velocity Docs t

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.

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.
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.

Originally published November 11, 2016, on the [Rackspace Blog](https://blog.rackspace.com/transforming-developer-and-support-documentation-with-docs-like-code).

Expand Down
2 changes: 1 addition & 1 deletion _posts/articles/2018-02-12-change-case-study.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ comments: false
share: true
---

**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.**
**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.**

{: .tip}
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.
Expand Down
2 changes: 1 addition & 1 deletion _posts/articles/2018-06-05-cloudify-dont-stop-dreaming.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ author: ben_mansheim
tags: [cicd, circleci, cloudify, Docker, docs, Hugo, Go]
image:
path: /images/cloudify/docs-as-code-blog-banner.png
caption: "[Courtesy Cloudify blog](https://cloudify.co/2018/06/05/docs-as-code-dont-stop-dreaming)"
caption: "[Courtesy Cloudify blog](https://cloudify.co/blog/docs-as-code-dont-stop-dreaming/)"
comments: false
share: true
---
Expand Down
6 changes: 3 additions & 3 deletions _posts/articles/2018-10-12-platformos-1of4.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ author: diana_lakatos
tags: [developer documentation, Design Thinking, Information Architecture, docs, documentation, UX]
image:
path: /images/platformos/platformos_part1/part1_cover.jpg
caption: "[Courtesy platformOS blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platform-os-part-1-information-architecture)"
caption: "[Courtesy platformOS blog](https://www.platform-os.com/blog/post/building-our-documentation-site-on-platform-os-part-1-information-architecture)"
comments: false
share: true
---
Expand Down Expand Up @@ -89,7 +89,7 @@ Based on the Content Inventory and the results of the Card Sorting sessions, we

_Sample page from our sitemap_

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.
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.

### Persona-based content prioritization

Expand All @@ -109,6 +109,6 @@ This concluded our Information Architecture phase. We have discovered and organi

_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._

_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)._
_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)._

{% include sign-up.html %}
4 changes: 2 additions & 2 deletions _posts/articles/2018-11-01-platformos-2of4.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ author: diana_lakatos
tags: [developer documentation, Content-First Design, community, style guide, templates, editorial workflow, wireframes, docs, documentation, UX]
image:
path: /images/platformos/platformos_part2/part2_cover.jpg
caption: "[Courtesy platformOS Blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platform-os-part-2-content-production-and-layouts)"
caption: "[Courtesy platformOS Blog](https://www.platform-os.com/blog/post/building-our-documentation-site-on-platform-os-part-2-content-production-and-layouts)"
comments: false
share: true
---
Expand Down Expand Up @@ -142,6 +142,6 @@ We hope you enjoyed learning about how we started content production, how we bui

_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._

_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)._
_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)._

{% include sign-up.html %}
4 changes: 2 additions & 2 deletions _posts/articles/2018-11-25-platformos-3of4.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ author: diana_lakatos
tags: [developer documentation, contributor experience, community, style guide, templates, editorial workflow, docs, documentation]
image:
path: /images/platformos/platformos_part3/part3_cover.jpg
caption: "[Courtesy platformOS Blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platformos-part-3-community)"
caption: "[Courtesy platformOS Blog](https://www.platform-os.com/blog/post/building-our-documentation-site-on-platformos-part-3-community)"
comments: false
share: true
---
Expand Down Expand Up @@ -112,6 +112,6 @@ Now that you’ve seen how we discovered the needs of our target audience, plann

_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._

_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)._
_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)._

{% include sign-up.html %}
16 changes: 8 additions & 8 deletions _posts/articles/2020-02-26-platformos-4of4.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ author: diana_lakatos
tags: [developer documentation, editorial workflow, API documentation, docs, documentation, contribution, testing, QA, performance]
image:
path: /images/platformos/platformos_part4/part4_cover.jpg
caption: "[Courtesy platformOS Blog](https://www.platformos.com/blog/post/blog/building-our-documentation-site-on-platformos-part-4-implementation)"
caption: "[Courtesy platformOS Blog](https://www.platformos.com/blog/post/building-our-documentation-site-on-platformos-part-4-implementation)"
comments: false
share: true
---

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.
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.

* [Part 1: Information Architecture](/articles/platformos-1of4)
* [Part 2: Content Production and Layouts](/articles/platformos-2of4)
Expand Down Expand Up @@ -132,14 +132,14 @@ In the near future, we are planning to implement **performance testing with real

If you’d be interested in learning more about our process and tools, check out our article series on QA and testing:

* [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)
* [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)
* [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)
* [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)
* [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)
* [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)
* [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)
* [QA and Testing Best Practices — Part 4: Performance Testing](https://www.platformos.com/blog/post/qa-and-testing-best-practices-part-4-performance-testing)

## Performance

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.
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.

### Measure early, measure often

Expand Down Expand Up @@ -256,7 +256,7 @@ We collect user feedback through Slack channels, the feedback block, user resear

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.

_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)._
_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)._

{% include sign-up.html %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ You will also see the content in the S3 bucket.

## Recap and summary

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.
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.

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.

Expand Down