Docs Q1 2020 OKRs

The official version of these OKRs can be found at the canonical public spreadsheet for permanent reference. They're also been added to the docs repo readme for easy public consumption.

1. Launch already-completed docs beta on IPFS

• A (P0): Launch docs beta site (completed in Q4) on IPFS, and follow up with executing comms plan
  • Deliverable: Beta site deployed
  • Owner: Chris (with help from others in the IPFS org) for deployment; Jessica for comms plan

2. Improve docs content by creating new material, improving existing material (aka paying down "docs debt"), and efficiently resolving new issues identified by metrics and community

• A (P2): Close 5+ high-value, content-related issues (candidate issues here) that also plug missing holes in our next-gen information architecture; content should be enhanced by diagrams or video, all produced either internally or using identified contractors and/or community contributors
  • Deliverable: Closed issues
  • Owner: Johnny and contract writers/artists
• B (P2): Recruit/enlist "army of contributors" via combination of bounty hunters, contractors, and community contributors
  • Deliverable: Organized stable of contributors and means of communicating with them efficiently (e.g. weekly open office hours)
  • Owner: Johnny
• C (P0): Efficiently triage all new docs issues raised by labbers or community; this includes ongoing monitoring of metrics to identify any problems that haven't been explicitly raised as issues
  • Deliverable: Fixed pages/items
  • Owner: Johnny
• D (P1): Provide guidelines and reference materials (issue here) that make it easier for internal and external contributors to write clear, consistent documentation
  • Deliverables: Contribution guidelines (presented in the docs site as well as alongside IPFS developer contributor guidelines); defined personality and writing style for docs, as reflected in a publicly-available style style guide; "code persona" and base example project to pull code-blocks and small examples from including example users (such as Apple's Johnny Appleseed).
  • Owner: Johnny

EXTRA: Items deferred to future quarters

Bring docs site out of beta by solidifying platform, testing with users, and roadmapping future work

• A: Research and complete a roadmap for improving and automating API/CLI documentation (issue here)

  • Deliverable: A report and roadmap for improving/automating API/CLI docs, including a platform decision (based on competitive analysis and best-in-breed research) and step-by-step timeline for implementation in Q2
  • Owner: Johnny (research, reporting) and Chris (viability confirmation)

• B: Deprecate legacy docs site

  • Deliverable: Ideally, deprecate the legacy docs site per the guiding document created in Q4. If this isn't possible during the quarter, clearly define a timeline for completion, including key dates for defining success.
  • Owner: Chris, Johnny

• C: Continue to improve docs platform via closing issues considered, but de-scoped, for initial launch

  • Deliverable: Close platform-related improvements (candidate issues here) that had been considered for beta launch but de-scoped for Q4 2019 implementation.
  • Owner: Chris (code), Eric (design)

• C: Conduct ongoing UX testing of new platform and revise as necessary

  • Deliverable: User testing plans, artifacts and reports for applicable OKR items; action items captured in PRs (for critical and/or simple fixes) or GitHub issues (for less critical or more complex ones)
  • Owner: Eric and Jessica

• D: Monitor features prioritization vote and adjust plans as necessary

  • Deliverable: Analysis of Canny votes and report on next steps
  • Owner: Eric, Jessica, Chris, Johnny