Skip to content

Commit 289aaa3

Browse files
committed
Starting draft of survey results
1 parent f636ffa commit 289aaa3

4 files changed

Lines changed: 40 additions & 0 deletions

File tree

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
layout: post
3+
title: Survey Results for learning and teaching docs-like-code techniques
4+
excerpt: "Review the results of a mid-2020 survey about learning and teaching team mates and yourself how to work with docs like code, Git, and GitHub for technical documentation."
5+
last_modified_at: Wed Jan 6 11:30:36 CST 2021
6+
categories: articles
7+
author: anne_gentle
8+
tags: [github, git, learning, teaching, documentation, developer, docs-like-code, onboarding]
9+
image:
10+
path: /images/othree-github-stickers.jpg
11+
caption: "[Flickr othree](https://flic.kr/p/bGFTuT)"
12+
comments: false
13+
share: true
14+
---
15+
16+
I asked three questions in a survey emailed to my mailing list and got more than 30 responses.
17+
18+
Here are the three questions:
19+
20+
Question 1: When you talk to your leaders about docs-as-code, can they describe the benefits as well as the difficulties?
21+
22+
Question 2: How do you onboard people who are new to your docs tools and processes?
23+
24+
Question 3: What tips or discussions (from any source) was most helpful to you when learning docs-as-code techniques?
25+
26+
Docs-as-code processes are still new in the field and it seems many of the responses are split, with no overwhelming patterns in any single area. Here are the charts for the first two questions.
27+
28+
29+
![](/images/survey-charts/leadership-docs-tools.png)
30+
31+
32+
33+
![](/images/survey-charts/how-onboard-docs.png)
34+
35+
36+
For question three, I wanted to share any nuggets found in the answers here on the Docs Like Code site, since the goal for this site is to learn these techniques together and share our stories. Here are some highlights. No, this is not a section simply to point to the book, rather, it's to show that having additional resources including people you can ask questions is super valuable when learning how to treat docs like code.
37+
38+
39+
40+
{% include sign-up.html %}

images/othree-github-stickers.jpg

5.04 MB
Loading
194 KB
Loading
304 KB
Loading

0 commit comments

Comments
 (0)