Just Write Click

Technical writing with Continuous Integration and docs-as-code

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

September 13, 2007 by annegentle

User and task analysis – or, how do I start writing anyway

My writing teammates and I are working through our favorite ways to start a project and do user and task analysis. The exercise forced me to write down what it is I do when starting a new project. My formal training began in graduate school but my practical training happened at only two different companies, […]

Filed Under: techpubs, writing Tagged With: analysis, personas, task analysis, techpubs, usability, user analysis, users, writing, writing assignments

May 19, 2007 by annegentle

Usability and inline links in user assistance systems

Examining DITA’s linking and usability In this month’s Central Texas DITA User Group meeting, we had an excellent presentation about linking using DITA maps and relationship tables by Scott Stark from IBM. He’s located in Austin and supports about 150 writers in California. His presentation is available for download from the Files section (membership required) […]

Filed Under: talk.bmc Tagged With: context linking, DITA, inline linking, link management, link usability, relationship tables, search engine friendly, search engine optimization, SEF, SEO, usability

August 30, 2006 by annegentle

Seducing users to learn by reading the manual

Thought provoking post over at Creating Passionate Users — shiny slick seducing user manuals From a recent post by Kathy Sierra at Creating Passionate Users, “What if instead of seducing potential users to buy, we seduced existing users to learn?” I don’t really like the title of her post, which is Why marketing should make […]

Filed Under: talk.bmc Tagged With: marketing communication, technical communications, technical publications, usability, user manuals

« 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