The Writers' Table


A technical writing series with information for both new and working writers.

This is a reading and practice group, not a course. Each post covers one topic — craft, tools, process, career, etc. — and ends with an exercise you can work through. As articles are added, you can work through them in any order.

The articles aren’t exhaustive. They’re designed and written to give you a starting point.

I’m also including references for further exploration with the articles.

writerstable

This started with twice a week posts; I’ve changed that cadence to three posts per week — Monday, Wednesday, and Friday — starting Monday, July 27. New and working writers both welcome.

I am posting the articles to my “The Way We Write Now” Substack. It’s free; there is no subscription or pledge fee.

Articles begin Monday, July 6. Follow along using the button here, and bookmark this page for the link to each article as they go live.

Follow Along →

NOTE! On the Subscription page, please click “No Pledge” if you see it!


Phase 1: Foundation

What the Job Is

Writing Craft

Editing

Phase 2: Working with People & Structure

Working with People

Content Structure

  • 5A: Documentation Frameworks: A Field Guide (coming July 31)
  • 5B: Stop the Sprawl: Information Architecture (coming August 3)
  • 5C: Metadata and Taxonomy (coming August 5)

Phase 3: Content Types — What You Produce

API Documentation

  • 6A: API Docs 101: Demystifying REST (coming August 7)
  • 6B: Beyond REST: OpenAPI and Swagger (coming August 10)

Developer Documentation

  • 7A: From Git Commits to Release Notes (coming August 12)
  • 7B: Code Samples and Code Comments (coming August 14)

UX Writing & Accessibility

  • 8A: Words in the Machine: Intro to UX Writing (coming August 17)
  • 8B: Writing for Everyone: Accessibility (coming August 19)

Visual Communication

  • 9A: Visuals That Work (and Don’t) (coming August 21)
  • 9B: Diagrams as Code: Mermaid & Draw.io (coming August 24)

Phase 4: The Modern Toolchain

Authoring Environments

  • 10A: The Shift to Docs-as-Code (coming August 26)
  • 10B: Choosing Your Authoring Environment (coming August 28)

Style & Automation

  • 11A: Enforcing Style Guides Without Being a Cop (coming August 31)
  • 11B: Automated Linting and Consistency Checking (coming September 2)

Phase 5: Scale & Strategy

Scalable Documentation

  • 12A: Write Once, Publish Everywhere (coming September 4)
  • 12B: Modular Docs and the Philosophy of DITA (coming September 7)

Global Strategy

  • 13A: Writing for Translation and Localization (coming September 9)
  • 13B: The Technical Writer as Strategist (coming September 11)

Phase 6: AI

AI as Tool and Subject

  • 14A: The Writer as Context Owner (coming September 14)
  • 14B: Prompt Engineering for Tech Writers (coming September 16)
  • 14C: Documenting AI and Non-Deterministic Software (coming September 18)

Phase 7: Process, Metrics & Maintenance

Agile & Task Management

  • 15A: Surviving the Two-Week Sprint (coming September 21)
  • 15B: Task Management and Ticket Systems (coming September 23)

Metrics & Maintenance

  • 16A: Proving Your Worth: Documentation Metrics (coming September 25)
  • 16B: The Art of Deleting: Content Audits (coming September 28)

Phase 8: Career

Career Development

  • 17A: Building the NDA-Proof Portfolio (coming September 30)
  • 17B: Contracting vs. Full-Time (coming October 2)