forked from San-Francisco-Write-The-Docs/lone-writers-guide
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathInheritingAMess
48 lines (34 loc) · 1.62 KB
/
InheritingAMess
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
<!-- https://docs.google.com/document/d/1B9LI0ALhIVtuZndvCXEHD-289gLw1Fesaexwc0UhSqA/edit# -->
*****************
Inheriting a mess
*****************
=================================================================
How to swim in the deep water - A lone writer’s guide to survival
=================================================================
Starting notes:
---------------
Inheriting docs from a writer who left before you started.
Challenges.
When to keep the process/tools from a previous writer and when to change process and tools.
Hack-a-thon content:
--------------------
Joe
Inherited flat, unrefined knowledge base
Overlapping content
Redundant knowledge
1 person team
Try to understand what the goals/priorities were of previous solution vs what goals you’re trying to accomplish now.
Keep your priorities in mind when determining next steps.
Make sure solution is scalable; once you have a better solution, other teams will want in.
If your audience is internal and cross-department, consider if gating content with permissions will solve existing problems.
How much content will change?
Define your hierarchy
Keep audience in mind
Organize docs by function/purpose/types
Depending on whether you’re inheriting internal or external-facing content, consider breaking down content by either product/category or per-department. Using both will get messy.
Define stakeholders
Look at organizational structure of company
Revamping ALL docs or just department docs?
Style guide
Standardization of terminology
Audience “This page intended for…”