Session 1 Notes – TC Camp 2019

TRANSCRIPTIONS ARE IN PROGRESS.

#1 (API) Tools for documenting REST APIs

  • What was written on the original topic used in the voting?

Scribe: WHO?

Top takeaways:

  • ….

Notes:


#2 Managing expectations in big projects

You have stakeholders, and they all want things. Different things. You can do some things; you can’t do others. Beyond the SME relationship, what can we do as technical writers to assert influence and complete big projects as heroes with happy stakeholders?

Scribe: Jill Elhonsali

Top takeaways:

  • 8 hrs/page – industry standard (includes management)
  • Create project plan with milestones – update when slips/changes to schedule
  • Meet with stakeholders; get invited to meetings
  • Public schedule
  • Publicize process – need TechComm
  • Communicate Tech Pubs process – make people understand

Notes:

  • Need to educate managers, amount of time to complete project
  • Need to evaluate time vs resources
  • Eng, marketing, Tech Comm, Mfg, ERD (Eng Req Doc) MRD (Mktg Rq Doc) basis of techdoc
  • Create milestones – per chapter or subset
  • Need to be aware of changes to products – attend scrums, product meetings
  • Project with no deadlines – especially in pharma: create project plan with when you can deliver doc and send to requester. Meet with all stakeholders
  • Public whiteboard with schedule
  • Agile, scrum, scaled agile for enterprise
  • Cloud – fluid
  • Increase visibility – jira approval by techcomm

#3 Exploring Gdocs output


  • What was written on the original topic used in the voting?

Scribe: WHO?

Top takeaways:

  • ….

Notes:


#4 Information architecture

  • What was written on the original topic used in the voting?

Scribe: WHO?

Top takeaways:

  • ….

Notes:


#5 Creating microcontent

  • What was written on the original topic used in the voting?

Scribe: WHO?

Top takeaways:

  • ….

Notes:


#6 Amphitheater

Lightning talk #1: Does Your Conditional Filtering Strategy Scale?

Presenter: Mike Rice

Scribe: Cheryl Smith

Top takeaways:

  • Mike Rice with Jorsek (formerly at Xerox)
  • Using Feature-based Metadata to improve Maintainability
  • Mistakes I made using Conditionalization

Notes:

  • Content can contain compound conditions:
    • Obsolete condition
    • Implicit relationships
  • This becomes messy, creates a bottleneck and causes time expenditure in re-working instead of writing.
  • Solution:
    • Place conflicting items next to each other for analysis (features vs. product is an example)
    • Use Feature-based Metadata

Lightning talk #2: Documentation Tools as a Career

Presenter: Mark Giffin

Scribe: Cheryl Smith

Notes:

  • For a career, it should be a person who enjoys messing with Tools and has an interest in programming.
  • Today the Technical Writer is the tools developer, DITA configuration manager, etc.
  • In Future:
    • IA/Chatbots need more tools expertise
    • Lightweight DITA, Markdown (?)
      • Markup Language
    • Shorthand HTML
      • Static Generator