Just Write Click

Technical writing with Continuous Integration and docs-as-code

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code

March 26, 2009 by annegentle

Twitter for usability testing or doc testing? Sure, here’s how

Twitter for usability testing or doc testing? Sure, here’s how

My coworker went to SXSW Interactive this year, and I merely went to lunch with people near SXSWi and followed the #sxswi Twitter stream, and now I am browsing through the sketchnotes. I went to BarCamp Austin on Saturday and presented about FLOSS Manuals and the Book Sprint methodology we’ve been experimenting with. It went […]

Filed Under: social media, techpubs Tagged With: documentation, quality, reviewing, techpubs, testing, twitter, usabilty

February 5, 2009 by annegentle

Examples of blogs as online help and release notes

I’m always on the lookout for examples of social media tools used to write and maintain online help. One trend I think I am seeing is the use of blogs as the basic release notes for new features in products, especially web applications. Examples are new Google Calendar features and SmugMug, where the entire blog […]

Filed Under: techpubs Tagged With: blogging, blogs, documentation, new features, online help, release notes, user assistance

January 8, 2009 by annegentle

How many roles can a documentation expert have in a company?

How many roles can a documentation expert have in a company?

Harjot Dhodi asked, “What is the difference in the role of: Document Architect, Template Designer, Writer, Technical Editor, and Production Editor? Can a person be told to handle all these roles?” I’ll try to examine these roles one at a time, and then answer the final question last. Document Architect – Typically this person has […]

Filed Under: techpubs Tagged With: architect, designer, documentation, editor, production, technical publications, template, writer

« Previous Page
Next Page »

More reading

Bubble graph showing sources of developer support data

I’ve been thinking a lot about developer support at Cisco recently, especially for the way the world works today with multiple cloud providers. This post is a re-publish of my talk from over five years ago, but the techniques and tools for listening and helping others are still true today. At Rackspace, we watched several […]

Cisco DevNet is our developer program for outreach, education, and tools for developers at Cisco. From the beginning, the team has had a vision for how to run a developer program. Customers are first, and the team implements what Cisco customers need for automation, configuration, and deployment of our various offerings. Plus, the DevNet team […]

I had a great talk with Ellis Pratt of Cherryleaf Technical Writing consulting last week. Here are the show notes, full of links to all the topics we covered. Podcasts are great fun to listen to and participate in, if a bit nerve-wracking to think on your feet and make sure you answer questions succinctly […]

At the beginning of this year, I worked hard to summarize my thoughts on API documentation, continuous publishing, and technical accuracy for developer documentation. The result is an article on InfoQ.com, edited by Deepak Nadig, who also was forward-thinking in having me speak to a few teams at Intuit about API documentation coupled with code. Always […]

Recently on Just Write Click

  • A Flight of Static Site Generators: Sampling the Best for Documentation
  • Try a GPT about “Docs Like Code” to ask questions
  • Discipline and Diplomacy: Docs in the Open
  • Let’s Find Out: When Do Static Site Generators Do Rendering?
  • GitHub for Managing Tech Docs

Just Write Click in your Inbox

Enter your email address to subscribe to Just Write Click and receive notifications of new posts by email.

Read More

  • Privacy Policy
  • About Anne Gentle, developer experience expert
  • Books by Anne Gentle
    • Conversation and Community
    • Docs Like Code, a Book for Developers and Tech Writers
  • Woman in Tech Speaker Profile
  • Contact

Books

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code

Copyright © 2025 · WordPress · Log in