Just Write Click

Technical writing with Continuous Integration and docs-as-code

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

June 27, 2006 by annegentle

How much markup is enough for a wiki?

The answer is, it depends I noticed that the MSDN wiki for Visual Studio has just three markup tags for content edits. It appears you get basically three tags: heading, body, and code. Now, in their case, they have strictly defined what they intend for users to enter in their wiki, which is intended to […]

Filed Under: talk.bmc Tagged With: DITA, MSDN, wiki

June 23, 2006 by annegentle

Troubleshooting tip for the DITA Open Toolkit installation

Finally figured out the fix for my DITA Open Toolkit “resource/messages.xml” not found error Thanks to David Brainard for figuring out the basic problem! At BMC, we all have a Documentum client installed on our desktops, so with the 4i client, my Classpath contained C:\Program Files\Documentum\Shared\dfc.jar. Apparently there is a collision of some sort between […]

Filed Under: talk.bmc Tagged With: DITA, DITA Open Toolkit

May 31, 2006 by annegentle

Defining OPML and relating to DITA maps

I found a nice definition for OPML from whatis.com as their word of the day, and I’m starting to wonder about similarities between OPML and DITA maps From an information design perspective, OPML is a great format for outlining information, showing information’s hierarchical structure and relationship to other entries. I had only really thought about […]

Filed Under: talk.bmc Tagged With: DITA, OPML

« 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