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/2018-10-12-platformos-1of4.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,19 @@
1
1
---
2
2
layout: post
3
-
title: "Building Our Documentation Site on Platform OS — Part 1: Information Architecture"
4
-
excerpt: This article series describes our process for building the Platform OS 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.
5
5
last_modified_at: Fri Oct 12 21:01:44 CDT 2018
6
6
categories: articles
7
7
author: diana_lakatos
8
8
tags: [developer documentation, Design Thinking, Information Architecture, docs, documentation, UX]
caption: "[Courtesy Platform OS blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platform-os-part-1-information-architecture)"
This article series describes our process of building our [documentation site](https://documentation.platform-os.com/) for [Platform OS](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:
17
17
18
18
* Part 1: **Information Architecture**
19
19
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
24
24
* Part 4: **Implementation**
25
25
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.
26
26
27
-
All these articles together will show you a complete framework for building a documentation site on Platform OS.
27
+
All these articles together will show you a complete framework for building a documentation site on PlatformOS.
28
28
29
29
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.
30
30
@@ -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 [Platform OS Blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platform-os-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-platform-os-part-1-information-architecture)._
Copy file name to clipboardExpand all lines: _posts/articles/2018-11-01-platformos-2of4.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,19 @@
1
1
---
2
2
layout: post
3
-
title: "Building Our Documentation Site on Platform OS — Part 2: Content Production and Layouts"
3
+
title: "Building Our Documentation Site on PlatformOS — Part 2: Content Production and Layouts"
4
4
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.
caption: "[Courtesy Platform OS Blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platform-os-part-2-content-production-and-layouts)"
Welcome to part 2 of our article series where we describe the process of building the [Platform OS 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.
17
17
18
18
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.
19
19
@@ -136,12 +136,12 @@ _Wireframe for the tutorial topic type_
136
136
137
137
As you can see from the process so far, we put our focus on audience, content, and UX — leaving visual design for later.
138
138
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 Platform OS 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.
140
140
141
141
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!**
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 [Platform OS Blog](https://www.platform-os.com/blog/post/blog/building-our-documentation-site-on-platform-os-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-platform-os-part-2-content-production-and-layouts)._
0 commit comments