Skip to content

Commit

Permalink
[Australia] Add Tales from the Trenches page (#2251)
Browse files Browse the repository at this point in the history
* Add Tales to menu-mobile.html

* Add Tales to menu-desktop.html

* Create tales.rst

* Update menu-mobile.html

* Update menu-desktop.html

* fix link

* Add paragraphs to break the walls of text

* Update docs/conf/australia/2024/tales.rst

Co-authored-by: Sam <[email protected]>

* Edits from Sam tales.rst

* Update australia-2024-schedule.yaml

* Update lightning-talks.rst

Add link to Tales from the Trenches

* Remove Felicia from the speakers

---------

Co-authored-by: Sam <[email protected]>
  • Loading branch information
flicstar and plaindocs authored Nov 6, 2024
1 parent 2e0f832 commit 3f5f825
Show file tree
Hide file tree
Showing 6 changed files with 56 additions and 28 deletions.
2 changes: 1 addition & 1 deletion docs/_data/australia-2024-schedule.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ talks_day2:
- duration: '0:20'
title: '☕ Coffee break'
- duration: '0:30'
slug: creating-truly-accessible-documentation-felicia-sephodi
title: '<a href="../tales/">Tales from the Trenches</a>'
- duration: '0:10'
title: '✋ 10 min Q&A'
- duration: '0:15'
Expand Down
25 changes: 0 additions & 25 deletions docs/_data/australia-2024-sessions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,31 +32,6 @@
<p>In this session, I’ll share the journey of implementing a documentation survey and
fixing it by dissecting the survey mechanism, enhancing feedback paths, updating our
survey design, and integrating survey results with our data analytics platform.</p>'
- title: Creating truly accessible documentation
slug: creating-truly-accessible-documentation-felicia-sephodi
series: Write the Docs Australia
series_slug: australia
year: 2024
speakers:
- name: Felicia Sephodi
slug: felicia-sephodi
twitter:
website:
abstract: '<p>I recently gave a talk at another conference on accessible development
and after I gave the talk, I had to take a technical writing for accessibility
course where I learned about the art of creating useful alt text. It happened
that during my slides creation, some of my examples were not inclusive of audiences
with disabilities, I later realized that was also a pattern in my workplace. This
session is a mixture of what I learned in detail, creating documentation
for all users and advanced ways for making documentation usable for everyone.</p>
<p>Understanding the art of creating disability-friendly content, I will explain
the problem with the alt text during my talk and how I solved it. Additionally,
I will show ways to create effective alt text and content that adapts
depending on the user. The session will also touch on inclusive design patterns as
a method for helping create accessible documentation. Lastly, I will highlight
efforts for collaboration, testing and ensuring that everyone is on board with
accessibility in documentation design.</p>'
- title: Mastering review comments — Fine-tuning feedback for better docs
slug: tips-for-great-review-comments-cameron-shorter
series: Write the Docs Australia
Expand Down
3 changes: 3 additions & 0 deletions docs/_templates/2024/menu-desktop.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@
{% if not flagisvirtual %}
<li><a href="{{ pathto('conf/'+shortcode+'/'+year_str+'/sponsor-expo') }}">Sponsor Expo</a></li>
{% endif %}
{% if shortcode == "australia" %}
<li><a href="{{ pathto('conf/'+shortcode+'/'+year_str+'/tales') }}">Tales From the Trenches</a></li>
{% endif %}
{% if flaghashike %}
<li><a href="{{ pathto('conf/'+shortcode+'/'+year_str+'/hike') }}">Hike</a></li>
{% endif %}
Expand Down
3 changes: 3 additions & 0 deletions docs/_templates/2024/menu-mobile.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@
{% if not flagisvirtual %}
<li><a href="{{ pathto('conf/'+shortcode+'/'+year_str+'/sponsor-expo') }}">Sponsor Expo</a></li>
{% endif %}
{% if shortcode == "australia" %}
<li><a href="{{ pathto('conf/'+shortcode+'/'+year_str+'/tales') }}">Tales From the Trenches</a></li>
{% endif %}
{% if flaghashike %}
<li><a href="{{ pathto('conf/'+shortcode+'/'+year_str+'/hike') }}">Hike</a></li>
{% endif %}
Expand Down
6 changes: 4 additions & 2 deletions docs/conf/australia/2024/lightning-talks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ We have two categories for people who submit talks:
We do this so we have a mix of first time and experienced speakers.
We also want first-time speakers to know that we care about them having a chance to get on stage.

**You can sign up for lightning talks each day of the conference** `on our Google Form <https://forms.gle/ULLEXmkXHymanNEP9>`_.

Planning: What goes into a lightning talk?
------------------------------------------

Expand All @@ -32,6 +30,8 @@ First, you need a **topic**. Your topic might be:
- A retrospective, or what went right/wrong during a project you did or are doing
- Anything relevant that the audience might be interested in knowing more about

**Stuck for an idea?** Check out `Tales from the Trenches`_, a session for lightning talks focussed around three different topics.

Next, you need an **outline** for the content. Think about the **audience**, and the **goal** of your talk. Choose points to make that will be understandable by the audience and achieve your presentation goal. Remember how quickly five minutes goes by when choosing what to include!

Potential **points of interest** might be:
Expand Down Expand Up @@ -80,3 +80,5 @@ License
Thanks to the lovely Portland Python Users Group for use of this content.

Lightning Talks: A Guide for Beginners by Michelle Rowley of PDX Python is licensed under a `Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License <http://creativecommons.org/licenses/by-nc-sa/4.0/>`__.

.. _Tales from the Trenches: https://www.writethedocs.org/conf/australia/2024/tales/
45 changes: 45 additions & 0 deletions docs/conf/australia/2024/tales.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
:template: {{year}}/generic.html

Tales from the Trenches
=======================

**Where real stories meet tech docs.** This year, Write the Docs Australia is excited to introduce "Tales from the Trenches"—a new initiative inviting attendees to share their unique experiences and offer fresh perspectives.

We’re offering the usual `lightning talks`_ session on Day 1, but with "Tales from the Trenches" on Day 2, we’re setting three broad topics to help spark ideas and focus your stories.

Why join in?
------------

Great things happen when we share what we know. Our community is made up of technical writers, programmers, support teams, developer advocates, content strategists, and more; and we all work in such different spaces—public, private, and open source.

Sometimes the best conversations are the ones that happen in the hallway between sessions. With "Tales from the Trenches," we’re bringing those gems onto the stage for everyone to hear and enjoy.

Who’s it for?
-------------

"Tales from the Trenches" is for everyone\! Whether you’re a natural on stage or this is your first time holding the mic, all are welcome. Some of us have great stories but aren’t sure what’s worth sharing, while others want to speak but don’t know where to start.

This is a relaxed, open space for all of us to share a story or two. We’re all peers here, learning from each other as we go.

How It Works
------------

- **Talks on Day 2**: "Tales from the Trenches" will close out Day 2 with 5-7 minute lightning-style talks—no slides, just you and your story.
- **Pick a topic**: Choose from one of our three topics to get your ideas flowing.
- **Sign up**: Add your name to the sheet when you register to claim your spot under a topic. If spots fill up fast, we’ll draw names to keep things fair.

Topics for your tales
---------------------

- **AI in documentation** – What problem did AI ***not*** solve for you? How has AI changed how you work? This could include experiences with AI tools, automation, challenges, and how tech writers are navigating the world of AI.
- **Tech writing fails & documentation horror stories** – We’ve all been there. Whether it’s an embarrassing moment, a big mistake, or just a funny story, we’ve all had fails. Tell us what happened and what you learned!
- **Soft skills in technical writing** – What’s a soft skill that’s made a difference in your work? Share stories about resilience, time management, dealing with imposter syndrome, mentoring others, or balancing feedback.

Your five minutes of fame!
--------------------------

Whether it’s a documentation horror story, a tech-writing hack, or a valuable lesson learned, your story matters. Step up, share a tale, and make your mark at the conference\! Plus, by contributing, you’ll be adding to a rich, diverse experience that everyone can learn from.

**Note:** All talks will be recorded (unless you'd rather opt out) and shared on the Write the Docs Australia YouTube channel.

.. _lightning talks: https://www.writethedocs.org/conf/australia/2024/lightning-talks/

0 comments on commit 3f5f825

Please sign in to comment.