Skip to content

Commit f30137b

Browse files
Update 2018-11-25-platformos-3of4.md
1 parent e875a16 commit f30137b

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

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