Skip to content

Commit 44c09d3

Browse files
authored
Merge pull request #150 from diana-lakatos/master
Adds part 4 of platformOS article series, fixes previous articles
2 parents eb30a46 + f30137b commit 44c09d3

13 files changed

Lines changed: 287 additions & 23 deletions

_posts/articles/2018-10-12-platformos-1of4.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
22
layout: post
3-
title: "Building Our Documentation Site on PlatformOS — Part 1: Information Architecture"
4-
excerpt: This article series describes our process for building the PlatformOS documentation site, with in-depth insights into our approach, decisions, and plans. In this part, we share how we started, how we got to know our audience, how we figured out what content we need, and how we outlined a sitemap for our documentation site.
3+
title: "Building Our Documentation Site on platformOS — Part 1: Information Architecture"
4+
excerpt: This article series describes our process for building the platformOS documentation site, with in-depth insights into our approach, decisions, and plans. In this part, we share how we started, how we got to know our audience, how we figured out what content we need, and how we outlined a sitemap for our documentation site.
55
last_modified_at: Fri Oct 12 21:01:44 CDT 2018
66
categories: articles
77
author: diana_lakatos
88
tags: [developer documentation, Design Thinking, Information Architecture, docs, documentation, UX]
99
image:
1010
path: /images/platformos/platformos_part1/part1_cover.jpg
11-
caption: "[Courtesy PlatformOS blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platform-os-part-1-information-architecture)"
11+
caption: "[Courtesy platformOS blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platform-os-part-1-information-architecture)"
1212
comments: false
1313
share: true
1414
---
1515

16-
This article series describes our process of building our [documentation site](https://documentation.platform-os.com/) for [PlatformOS](https://www.platform-os.com/), with in-depth insights into our approach, decisions, and plans. We have planned four parts for this series, each describing a unique aspect of our journey:
16+
This article series describes our process of building our [documentation site](https://documentation.platform-os.com/) for [platformOS](https://www.platform-os.com/), with in-depth insights into our approach, decisions, and plans. We have planned four parts for this series, each describing a unique aspect of our journey:
1717

1818
* Part 1: **Information Architecture**
1919
In this part, we share how we started, how we got to know our audience, how we figured out what content we need, and how we outlined a sitemap for our documentation site.
@@ -24,7 +24,7 @@ This article series describes our process of building our [documentation site](h
2424
* Part 4: **Implementation**
2525
In this part, we take a look under the hood, and discuss the technologies we used, how we built our auto-generated API Reference, and how we pull content and related information from Github. We also share our future plans with you.
2626

27-
All these articles together will show you a complete framework for building a documentation site on PlatformOS.
27+
All these articles together will show you a complete framework for building a documentation site on platformOS.
2828

2929
We are continuously working on our documentation, but decided to make it public early on to get valuable feedback and show you the whole process, so please expect the documentation site to change and evolve while you learn more about it through these articles. At the time of the publication of this article, our documentation site is in alpha.
3030

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

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

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/blog/building-our-documentation-site-on-platformos-part-1-information-architecture)._
113113

114114
{% include sign-up.html %}

_posts/articles/2018-11-01-platformos-2of4.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
22
layout: post
3-
title: "Building Our Documentation Site on PlatformOS — Part 2: Content Production and Layouts"
3+
title: "Building Our Documentation Site on platformOS — Part 2: Content Production and Layouts"
44
excerpt: Welcome to part 2 of our article series where we discuss how content production started, and how we created the layouts and navigation for the site.
55
last_modified_at: Thu Nov 01 22:01:44 CDT 2018
66
categories: articles
77
author: diana_lakatos
88
tags: [developer documentation, Content-First Design, community, style guide, templates, editorial workflow, wireframes, docs, documentation, UX]
99
image:
1010
path: /images/platformos/platformos_part2/part2_cover.jpg
11-
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)"
11+
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)"
1212
comments: false
1313
share: true
1414
---
1515

16-
Welcome to part 2 of our article series where we describe the process of building the [PlatformOS documentation site](https://documentation.platform-os.com/) from discovery to development, with in-depth insights into our approach, decisions, plans, and technical implementation.
16+
Welcome to part 2 of our article series where we describe the process of building the [platformOS documentation site](https://documentation.platform-os.com/) from discovery to development, with in-depth insights into our approach, decisions, plans, and technical implementation.
1717

1818
Now that you’ve seen how we explored the needs of our audience, outlined the types of content we’d work on, and created a sitemap in part 1, let’s move on to discuss how content production started, and how we created the layouts and navigation for the site.
1919

@@ -136,12 +136,12 @@ _Wireframe for the tutorial topic type_
136136

137137
As you can see from the process so far, we put our focus on audience, content, and UX — leaving visual design for later.
138138

139-
Both the Design Thinking approach, and the Content-First approach we described in this article push visual design to a later stage. At the same time, the branding of PlatformOS is still in the making — with the help of the wonderful [Yiying Lu](https://www.linkedin.com/in/yiyinglu/). This means, that by the time our branding is done, we will have a working documentation site tested with real users, continuously improved based on relevant feedback. We believe that this way we could focus on the most important aspects for each phase, and our documentation site will have a solid foundation that the design can enhance. This is why, for now, we went with a very simple, clean design.
139+
Both the Design Thinking approach, and the Content-First approach we described in this article push visual design to a later stage. At the same time, the branding of platformOS is still in the making — with the help of the wonderful [Yiying Lu](https://www.linkedin.com/in/yiyinglu/). This means, that by the time our branding is done, we will have a working documentation site tested with real users, continuously improved based on relevant feedback. We believe that this way we could focus on the most important aspects for each phase, and our documentation site will have a solid foundation that the design can enhance. This is why, for now, we went with a very simple, clean design.
140140

141141
We hope you enjoyed learning about how we started content production, how we built our editorial workflow, and how we created wireframes for our documentation site. **Stay tuned to learn more about the community aspects of our docs in part 3 of our series!**
142142

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

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/blog/building-our-documentation-site-on-platformos-part-2-content-production-and-layouts)._
146146

147147
{% include sign-up.html %}

_posts/articles/2018-11-25-platformos-3of4.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
22
layout: post
3-
title: "Building Our Documentation Site on PlatformOS — Part 3: Community"
3+
title: "Building Our Documentation Site on platformOS — Part 3: Community"
44
excerpt: Welcome to part 3 of our article series where we explore how we collaborate with our community.
55
last_modified_at: Thu Nov 25 22:01:44 CDT 2018
66
categories: articles
77
author: diana_lakatos
88
tags: [developer documentation, contributor experience, community, style guide, templates, editorial workflow, docs, documentation]
99
image:
1010
path: /images/platformos/platformos_part3/part3_cover.jpg
11-
caption: "[Courtesy PlatformOS Blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platformos-part-3-community)"
11+
caption: "[Courtesy platformOS Blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platformos-part-3-community)"
1212
comments: false
1313
share: true
1414
---
1515

16-
In this [article series](/articles/platformos-1of4) we describe the process of building the [PlatformOS documentation site](https://documentation.platform-os.com/) from discovery to development, with in-depth insights into our approach, decisions, plans, and technical implementation. Welcome to part 3, where we explore how we collaborate with our community.
16+
In this [article series](/articles/platformos-1of4) we describe the process of building the [platformOS documentation site](https://documentation.platform-os.com/) from discovery to development, with in-depth insights into our approach, decisions, plans, and technical implementation. Welcome to part 3, where we explore how we collaborate with our community.
1717

1818
# Community-driven documentation
1919

@@ -52,9 +52,9 @@ In order to encourage collaboration and keep our community up-to-date with what
5252

5353
Our main communication channel for now is a dedicated Slack channel, where community members **ask questions, share ideas, and get to know our team members and each other**.
5454

55-
Here, they can ask questions about anything related to PlatformOS, and someone from our team, or another community member who has the answer will jump in to reply. We get a wide variety of questions from business related enquiries like pricing to specific questions about development.
55+
Here, they can ask questions about anything related to platformOS, and someone from our team, or another community member who has the answer will jump in to reply. We get a wide variety of questions from business related enquiries like pricing to specific questions about development.
5656

57-
This is also the place where both we and our community members **share news**. We let them know of new **features planned, bugs fixed, articles posted, and new docs added, and they show what they’re building on PlatformOS**. This constant exchange of information is extremely valuable for all involved: community members can share what they’ve learned, plan their module development in sync with our roadmap and each other’s projects, and allocate their resources according to what’s going on in the business and the wider community.
57+
This is also the place where both we and our community members **share news**. We let them know of new **features planned, bugs fixed, articles posted, and new docs added, and they show what they’re building on platformOS**. This constant exchange of information is extremely valuable for all involved: community members can share what they’ve learned, plan their module development in sync with our roadmap and each other’s projects, and allocate their resources according to what’s going on in the business and the wider community.
5858

5959
The Slack channel also provides a great opportunity for community members to start conversations, share relevant news and articles, and engage with like-minded professionals.
6060

@@ -76,13 +76,13 @@ _A documentation status report in our Slack channel_
7676

7777
## Weekly video conferencing
7878

79-
Initiated by our community, Town Hall is a weekly video conference over [Zoom](https://zoom.us/), where community members and the PlatformOS team share news, demo features and modules, and have the opportunity to engage in real-time, face-to-face conversation.
79+
Initiated by our community, Town Hall is a weekly video conference over [Zoom](https://zoom.us/), where community members and the platformOS team share news, demo features and modules, and have the opportunity to engage in real-time, face-to-face conversation.
8080

8181
Our team and community members are distributed over different continents, so we try to accommodate participants in different time zones by rotating the time of this event so that everyone has the chance to participate. We also share the recording of each meeting.
8282

8383
![](/images/platformos/platformos_part3/town_hall.jpg)
8484

85-
_Town Hall meeting: A community member demoing an application he developed on PlatformOS_
85+
_Town Hall meeting: A community member demoing an application he developed on platformOS_
8686

8787
## Surveys
8888

@@ -103,15 +103,15 @@ As our community grows, we are preparing to scale with it. Here are some of our
103103

104104
* **Topic wish list**: A feature that allows community members to add topics they’d like to see documented.
105105
* **Voting on topics**: Vote on topics, and we will start working on the topics with the most votes.
106-
* **Community site**: Our community members are active on many channels now, including on some of their own initiatives, like an Airtable for keeping track of community members, questions and answers, and community activities. Although it works for now, we are planning to give the PlatformOS community a home — a site similar to Intel Devmesh, a developer community site we built for Intel on PlatformOS.
107-
* **Community Manager**: In the near future, we are hiring a Community Manager to give the PlatformOS community dedicated attention from an experienced professional.
106+
* **Community site**: Our community members are active on many channels now, including on some of their own initiatives, like an Airtable for keeping track of community members, questions and answers, and community activities. Although it works for now, we are planning to give the platformOS community a home — a site similar to Intel Devmesh, a developer community site we built for Intel on platformOS.
107+
* **Community Manager**: In the near future, we are hiring a Community Manager to give the platformOS community dedicated attention from an experienced professional.
108108
* **Gamification**: After building a solid user flow, we are planning to strengthen it with gamification elements to help and reward the user’s journey from onboarding to mastering the site.
109-
* **Devcon**: We are planning a PlatformOS Devcon for 2019, a proper get-together for our community members with workshops and presentations by our team members and experienced members of our community.
109+
* **Devcon**: We are planning a platformOS Devcon for 2019, a proper get-together for our community members with workshops and presentations by our team members and experienced members of our community.
110110

111-
Now that you’ve seen how we discovered the needs of our target audience, planned content and layout for our documentation site, and connected with our community, all that’s left from our series is to show you how we implemented our documentation site on PlatformOS. See you again in part 4!
111+
Now that you’ve seen how we discovered the needs of our target audience, planned content and layout for our documentation site, and connected with our community, all that’s left from our series is to show you how we implemented our documentation site on platformOS. See you again in part 4!
112112

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

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/blog/building-our-documentation-site-on-platformos-part-3-community)._
116116

117117
{% include sign-up.html %}

0 commit comments

Comments
 (0)