Skip to content

Commit d6666ee

Browse files
committed
Rename file for date purposes and add author metadata
1 parent 8b74d76 commit d6666ee

2 files changed

Lines changed: 35 additions & 19 deletions

File tree

_data/authors.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Authors
22

3+
anne_gentle:
4+
name: Anne Gentle
5+
picture: http://docslikecode.com/images/anne_gentle.jpg
6+
github: //github.com/annegentle
7+
twitter: annegentle
8+
bio: "Developer Experience Manager"
9+
310
rachel_whitton:
411
name: Rachel Whitton
512
picture: https://pantheon.io/sites/default/files/styles/540x540_top/public/RachelNew.jpg

_posts/articles/2021-01-06-survey-results-docs-like-code.md renamed to _posts/articles/2021-01-09-survey-results-docs-like-code.md

Lines changed: 28 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: post
33
title: Survey Results for learning and teaching docs-like-code techniques
44
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
5+
last_modified_at: Sat Jan 9 13:39:05 CST 2021
66
categories: articles
77
author: anne_gentle
88
tags: [github, git, learning, teaching, documentation, developer, docs-like-code, onboarding]
@@ -13,15 +13,13 @@ comments: false
1313
share: true
1414
---
1515

16-
I asked three questions in a survey emailed to my mailing list and got nearly 40 responses.
16+
I asked three questions in a survey emailed to my mailing list and got more than 30 responses. Thanks to everyone who took the time to share their stories and respond. Here are the three questions:
1717

18-
Here are the three questions:
18+
* Question 1: When you talk to your leaders about docs-as-code, can they describe the benefits as well as the difficulties?
1919

20-
Question 1: When you talk to your leaders about docs-as-code, can they describe the benefits as well as the difficulties?
20+
* Question 2: How do you onboard people who are new to your docs tools and processes?
2121

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?
22+
* Question 3: What tips or discussions (from any source) was most helpful to you when learning docs-as-code techniques?
2523

2624
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. Let's look into the data and charts for the first two questions.
2725

@@ -30,13 +28,18 @@ Docs-as-code processes are still new in the field and it seems many of the respo
3028
![](/images/survey-charts/leadership-docs-tools.png)
3129

3230
**Legend**
33-
26.8% Yes, my leader started our processes and makes it possible for us to use our current tools and processes.
34-
19.5% Yes, my leader can provide their leadership complete justification for our choices.
35-
19.5% No, I work in an environment where my tool selection does not need justification from a management chain.
36-
19.5% No, my leadership chain doesn't really know what I do or why I use certain tools.
37-
14.6% It depends on which leader I'm talking to.
3831

39-
In a way, nearly all the responses could be viewed as "leadership either supports the selection does not get in the way of tool selection." For about 65% of the responses, either leadership can justify, started the processes, or isn't a deciding factor.
32+
**26.8**% Yes, my leader started our processes and makes it possible for us to use our current tools and processes.
33+
34+
**19.5**% Yes, my leader can provide their leadership complete justification for our choices.
35+
36+
**19.5**% No, I work in an environment where my tool selection does not need justification from a management chain.
37+
38+
**19.5**% No, my leadership chain doesn't really know what I do or why I use certain tools.
39+
40+
**14.6**% It depends on which leader I'm talking to.
41+
42+
In a way, nearly all the responses could be viewed as "leadership either supports the selection does not get in the way of tool selection." For about two-thirds of the responses, either leadership can justify, started the processes, or isn't a deciding factor.
4043

4144
Looking at the number of lone writer responses in the next question, this indicator makes sense as five of thirty-five respondents noted that they were the only writer in the organization, which would make up 14% of all responses. Let's take a look.
4245

@@ -45,12 +48,18 @@ Looking at the number of lone writer responses in the next question, this indica
4548
![](/images/survey-charts/how-onboard-docs.png)
4649

4750
**Legend**
48-
14.6% Internal write-up only
49-
20.2% Meeting only
50-
1.1% Pre-built environment only
51-
5.6% Lone writer
52-
23.6% Internal write up and meeting
53-
34.8% Internal write-up, meeting, and pre-built environment
51+
52+
**14.6**% Internal write-up only
53+
54+
**20.2**% Meeting only
55+
56+
**1.1**% Pre-built environment only
57+
58+
**5.6**% Lone writer
59+
60+
**23.6**% Internal write up and meeting
61+
62+
**34.8**% Internal write-up, meeting, and pre-built environment
5463

5564
My favorite answer to this question was one I hadn't considered, where the person is a lone writer, but works with the devs to get the docs working in the source code repo. It's along the lines of "It's complicated."
5665

0 commit comments

Comments
 (0)