Just Write Click

Technical writing with Continuous Integration and docs-as-code

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

January 29, 2010 by annegentle

Email feedback mechanisms for online help

Email has become a universal conversation mechanism for business to business notification, customer to business communication, you name it. If you’re not doing so already, you can add email links so that readers can send emailed feedback to your technical documentation team. With advanced mailto markup you can automatically enter a subject line, indicate who […]

Filed Under: social media Tagged With: communication, conversation, email, Javascript

July 28, 2009 by annegentle

Twitter Guidelines from UK Government

According to this article in the Guardian, there’s a 5,000-word publication with the UK government’s guide to using Twitter. It’s available on scribd.com even, according to this Digital Engagement blog entry. I think there are good lessons to be learned here that are relevant to any technical communicator’s use of Twitter to communicate with customers, […]

Filed Under: social media Tagged With: communication, conversation, documentation, followers, government, quality, techpubs, testing, twitter, writing

October 23, 2007 by annegentle

Who else wants to be a technical communicator?

I have been reading many essays and articles lately about “where has technical writing gone” (including a nice reaction countering the manual-less existence Jared Spool perceives) and “woe is technical writing.” Okay, I made the last one up. But all of this reading and other recent experiences has made me think about the core competency […]

Filed Under: writing Tagged With: communication, design, Lego, minimalism, screenwriters, techpubs, writing

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