Skip to content

Focused Conversation: Internal documentation (part 2)

Photo of Barrie Byron
Hosted By
Barrie B. and 2 others
Focused Conversation: Internal documentation (part 2)

Details

We had so much to say about internal documentation in the June 16 meetup that we decided to continue the conversation on June 30!

It's time to reconnect with other documentarians! Join us for a focused and friendly conversation about internal documentation:

Internal documentation often doesn’t look or act the same as external documentation. It may involve different tools and workflows, and it definitely has different users. Let’s share stories and discuss! Here are a few questions to get the conversation started:

  • Questions we discussed in the June 16 meetup:
  • How are internal docs different from external docs?
  • What's going well with internal docs at your workplace? What's going not so well?
  • What tools do you use to write and publish internal docs?
  • Not yet discussed:
  • Who decides which processes need internal docs? How does that decision get made?
  • If different people create internal vs external docs, who triages and routes requests for new docs?
  • Some procedures require both internal and external documentation. How do you keep internal and external docs in sync?
  • If internal documentation is a priority at your workplace, what drives that? If it isn’t given enough priority/resources, what are ways to advocate for it?
  • What are the important parts of internal docs - what drives the need for internal docs?
  • New questions raised in the June 16 meetup:
  • I’m interested in learning more about info architecture. How do you structure your docs and keep them all organized?
  • People at my organization have trouble finding docs because: a) there are lots of places to look, and b) new people don’t know where to look. How do you help people find docs when they’re stored in multiple repositories across the organization?

Bring your thoughts and questions, and attend for as long as your schedule allows. Our goal is to give you an opportunity to support and network with each other.

The discussion will be held on Zoom, and the link will be posted on the Meetup event by the previous evening. To attend, please RSVP to the Meetup event. We use the attendees list to screen out Zoom bombers, so it's especially helpful if you have the same display name in Zoom as your name on Meetup. RSVPs are closed 30 minutes before the meeting starts to allow our moderators to manage the event more smoothly as our group continues to grow!

Photo of Write the Docs Florida group
Write the Docs Florida
See more events