Skip to content

Commit e271eaa

Browse files
committed
implement review; turned 'events.md' into a section with 'Community Hour discussions and presentations' as a second-level section under it
1 parent d07bd0e commit e271eaa

File tree

6 files changed

+77
-22
lines changed

6 files changed

+77
-22
lines changed
Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,21 @@ A new project can either be an existing project you are new to or a new project
2424

2525
Regardless of whether you join an existing project or help build one from scratch, certain principles can guide your documentation work from day one. Following them early helps you work efficiently, avoid friction, and maintain scalable documentation.
2626

27-
### keep everything simple
27+
### Keep everything simple
2828

2929
It's important to keep everything simple at the start. Your processes, technologies, and workflows should be as seamless as possible. This is because any wrong style choices, incorrect technology, or cumbersome information architecture may cause problems later.
3030

31-
Avoid excessive advanced planning. You don't need to write a complex style guide or grand website architecture plans. This takes too much time away from immediate needs.
31+
Avoid excessive advanced planning. You don't need to write a complex style guide or create grand website architecture plans. This takes too much time away from immediate needs.
32+
33+
Eliminate writing styles, markup formats, and technical decisions that make you dread creating content. Remove fragile structures that break with every change and avoid processes that require excessive effort to build or deploy. Tackle anything that costs too much to maintain before it consumes your time and energy.
3234

3335
Also, you don't need to create much content early on. It's natural for your documentation to develop in small increments, similar to your codebase or knowledge base.
3436

3537
### Address loose ends early
3638

37-
Any growth in the project will amplify even the smallest issues, so take action to address them early. Reconsider your drafting, editing, and writing processes if they are bad. Maintain processes that scale and remove any tools or workflows that make your work difficult.
39+
Any growth in the project will amplify even the smallest issues, so take action to address them early. If your drafting, editing, and writing processes make your work difficult, reconsider them. Additionally, only maintain processes and tools that can scale.
3840

39-
People often drop links, messages, or notes on wikis. This information accumulates quickly, so you must build a reliable and robust pipeline to address the backlog.
41+
You must keep track of any issues or tasks that people raise. People often drop links, messages, or notes on wikis to notify you, and this information accumulates quickly. So you must build a reliable and robust pipeline to address your backlog using the task management tool of your choice.
4042

4143
Also, consider how easily you can reverse decisions. For example, anchoring references to specific documents instead of using relative links may create problems later. This is because restructuring the website would require manual link updates or complex regular expressions.
4244

@@ -74,15 +76,7 @@ You can start by describing what already exists and prioritizing your content ma
7476

7577
Operate from a clear content map to navigate unfamiliar territory and guide discussions, planning, and writing. Start by publishing what you already know, then use future updates to expand coverage. Alternate between writing and refactoring in distinct phases to preserve focus and maintain quality.
7678

77-
### Address legacy and technical debt
78-
79-
Ruthlessly contain the impact of legacy issues from the start of a project. Use a prioritized list of problems from your content audit and eliminate bad processes as soon as you discover them.
80-
81-
Eliminate writing styles, markup formats, and technical decisions that make you dread creating content. Remove fragile structures that break with every change and avoid processes that require excessive effort to build or deploy. Tackle anything that costs too much to maintain before it consumes your time and energy.
82-
83-
Similar to cleaning code, approach cleanups in manageable sections. Refactor just enough to create space for new content. Decide whether to salvage existing content or scrap it entirely based on the long-term maintenance cost.
84-
85-
## Resources and further reading
79+
## Further reading
8680

8781
* [Docs for Developers](https://docsfordevelopers.com/)
8882
* [Articles by the Nielsen Norman Group](https://www.nngroup.com/)

website/library/explanation/community-hour-discussions/index.md renamed to website/events/community-hour-discussions/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
2+
(community-hour-discussions-and-presentations)=
3+
14
# Community Hour discussions and presentations
25

36
CODA's {ref}`Community Hour <community-hour>` offers valuable presentations and discussions on documentation topics. These topics provide practical insights and expert knowledge to help improve your documentation skills.

website/events/index.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Events
2+
3+
All events related to the Documentation Academy can be found in the [Documentation events calendar](https://calendar.google.com/calendar/ical/c_fa68c19aa0cf8aa5ecd73266f6c4d9e94a52053c875f36fd7cc054439b923f33%40group.calendar.google.com/public/basic.ics).
4+
5+
(community-hour)=
6+
7+
## Community Hour
8+
9+
**We host a [Community Hour](https://discourse.ubuntu.com/t/community-hour/42771) every week on a Friday, 16:00 UTC.**
10+
11+
Our _Community Hour_ sessions are an informal forum for discussions related to documentation.
12+
13+
Bring your Documentation Academy questions, share your work, or present topics you'd like to discuss. Everyone is welcome. No prior arrangements are necessary. You don’t need to sign-up, or register. Just click on the link to join, for as little or as much time as you can spare, at any time during the hour.
14+
15+
We occasionally host for more formal presentations, and these will be recorded. The recordings archive is below.
16+
17+
## Community Hour recordings
18+
19+
We record our Community Hour meeting if there's a presentation or a session we think may be beneficial. Below is the list of all current recordings:
20+
21+
|Date | Presenters | Demo / discussion and YouTube link|
22+
|--- | --- | ---|
23+
|01/03/24 | `Graham` | [Introduction to the Academy and team](https://www.youtube.com/watch?v=GT03aSdabJE)|
24+
|08/03/24 | `Graham` | [git and GitHub workflow demo](https://www.youtube.com/watch?v=EwRaJ_tyJ-k)|
25+
|15/03/24 | `Graham, Robert` | [GitHub UI and git user interfaces](https://www.youtube.com/watch?v=Vk5blPpwOGM)|
26+
|22/03/24 | `Robert` | [Free beer vs Freedom](https://www.youtube.com/watch?v=X5GfBMkQoy0)|
27+
|29/03/24 | `Graham` | [Text editor roundup](https://www.youtube.com/watch?v=Xc-_Uu6asgA)|
28+
|05/04/24 | `Andreia, Robert` | [Documentation testing and frameworks](https://www.youtube.com/watch?v=hoaI9RTvano)|
29+
|12/04/24 | `Graham, Robert` | [Authoring frameworks and markup languages](https://www.youtube.com/watch?v=9jijpeUMzP0)|
30+
|19/04/24 | `Graham` | [Closed task review and new task overview](https://www.youtube.com/watch?v=lwrc3u2-g2s)|
31+
|26/04/24 | `Graham` | [JIRA for task management](https://www.youtube.com/watch?v=vryGy5qCZBM)|
32+
|03/05/24 | `Graham` | [9 tips for better writing](https://www.youtube.com/watch?v=YQMULY0ksz0)|
33+
|10/05/24 | `Graham, Shane, Giulia, Robert, Andreia` | [Live from Madrid: QA session](https://www.youtube.com/watch?v=GWG-RekGkjo)|
34+
|17/05/24 | `Keirthana, Graham, Nick, Andreia, Robert` | [Live from Madrid: How to approach tutorials](https://www.youtube.com/watch?v=somxhyLJFa4)|
35+
|24/05/24 | `Graham` | [ Demonstration of Discourse and Sphinx docs systems]( https://www.youtube.com/watch?v=H3OK4rfKRiA )|
36+
|31/05/24 | `Graham, Ruth, Robert, Shane and Dimple` | [ What text editor do you use and why? ]( https://www.youtube.com/watch?v=5rrFfsdwsWo )|
37+
|07/06/24 | `Robert, Artem, Ruth, Bill, Graham` | [Documentation as Code](https://www.youtube.com/watch?v=AVNfH99KiME)|
38+
|14/06/24 | `Nick, Shane, Graham` | [Vale for testing documentation](https://www.youtube.com/watch?v=QpcY-UWKhxQ)|
39+
|21/06/24 | `Artem` | [Tips for getting hired as a technical writer or author](https://youtu.be/lAWWsq2JDt8)|
40+
|28/06/24 | `Keirthana` | [Technical Author or Technical Writer](https://youtu.be/udsfj1oE8Ns)|
41+
|05/07/24 | `Everyone` | [Open discussion on Artificial Intelligence (AI) and documentation](https://www.youtube.com/watch?v=SzFm0jnd0bc)|
42+
|12/07/24 | `Shane, Nick` | [10 ways to document terminal commands](https://www.youtube.com/watch?v=LwJMtk3Fbsg)|
43+
|19/07/24 | `Keirthana` | [How-to vs tutorial](https://www.youtube.com/watch?v=9Ct_vb-BK0s)|
44+
|26/07/24 | `Robert` | [Documentation and AI](https://youtu.be/S9rChUYSHk8)|
45+
|02/08/24 | `Artem` | [How to encourage engineers to write their own documentation](https://youtu.be/tj_jLv3zE6k)|
46+
|09/08/24 | `Graham` | [Technical writing anonymous: improve a document as a group](https://www.youtube.com/watch?v=kmGBdBFTl5Y)|
47+
|16/08/24 | `Yana` | [Industrial Standards and Documentation](https://www.youtube.com/watch?v=SZ4bCbCYf8Q)|
48+
|23/08/24 | `Giulia` | [The challenges of onboarding as a tech author](https://www.youtube.com/watch?v=2gAlGjQFjTY)|
49+
|06/09/24 | `Vladimir` | [Fight! Markdown vs reStructuredText vs AsciiDoc vs XML](https://www.youtube.com/watch?v=C0V0A8GGfAs)|
50+
|13/09/24 | `Artem` | [Documenting a new project](https://www.youtube.com/watch?v=l4VzYjsqUC4)|
51+
|20/09/24 | `Christian Ehrhardt` | [An engineering director's perspective on documentation](https://www.youtube.com/watch?v=2ShZxMJ26_A)|
52+
|27/09/24 | `Yana` | [Accessibility and documentation](https://www.youtube.com/watch?v=Egubho3-AM0)|
53+
|04/10/24 | `Graham` | [What we can learn from old synthesizer manuals](https://www.youtube.com/watch?v=Gpjw6PQtR3U)|
54+
|11/10/24 | `Artem` | [GitHub Actions for documentation](https://www.youtube.com/watch?v=zB2CGhGXpnc)|
55+
|18/10/24 | `Shane` | [Recipes and Software](https://www.youtube.com/watch?v=PW_gWv6OysM)|
56+
|06/12/24 | `Teodora, Joost De Cock` | [The inspiration behind freesewing.org](https://www.youtube.com/watch?v=SWyzQ3ChZ1I)|
57+
|13/12/24 | `David Ekete` | [Interactive RST and working with CODA](https://www.youtube.com/watch?v=_7pKdieSt74)|
58+
59+
See {ref}`community-hour-discussions-and-presentations` for summaries of each Community Hour.
60+
61+
```{toctree}
62+
:hidden:
63+
:maxdepth: 1
64+
65+
Community Hour discussions <community-hour-discussions/index>
66+
```

website/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The Open Documentation Academy is sponsored by [Canonical Ltd](https://canonical
4141
4242
Recognition <recognition>
4343
Release notes <release-notes>
44-
Academy events <events>
44+
Academy events <events/index>
4545
Participating projects <projects>
4646
Academy handbook <docs/index>
4747
Writing resources <library/index>

website/library/explanation/index.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

website/library/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,5 @@ This section is currently under development. If you'd like to contribute, please
4848
:maxdepth: 2
4949
5050
Reference <reference/index>
51-
Explanation <explanation/index>
5251
5352
```

0 commit comments

Comments
 (0)