Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Define "self serving docs" #329

Open
Tracked by #313
catmcgee opened this issue Jul 26, 2024 · 2 comments
Open
Tracked by #313

Define "self serving docs" #329

catmcgee opened this issue Jul 26, 2024 · 2 comments
Assignees

Comments

@catmcgee
Copy link
Collaborator

No description provided.

@catmcgee
Copy link
Collaborator Author

catmcgee commented Aug 5, 2024

to talk about in dev-rel sync

The developer personas can each build a unique app without coming to Discord

How do we track this

  • 75% of Discord questions can be answered by sending a link to docs
  • 70% of searches result in a click on the first three suggestions
  • 30% of first-time viewers should install the sandbox
    • Measured by time spent on installation page (should be 3-30 minutes)
  • Maintain a list of Aztec core components and ensure these are 95% covered (measured subjectively by devrel) in docs
    • Every [Aztec.nr](http://Aztec.nr) library
    • Every Aztec.js package
    • Key concepts
      • Accounts
      • Notes
      • PXE & TXE
      • Contracts (private/public state/functions)
      • Circuits (as much as a dev should know)
      • Portals
      • Fees
      • Privacy
      • CLI
      • LSP
      • Testing

Developer personas

  • Solidity developers
  • Noir & circom developers
  • Aztec developers (ppl already building)

@catmcgee
Copy link
Collaborator Author

catmcgee commented Aug 5, 2024

  • Weeks 1-2 (August 1-14):
    • Devnet docs
    • New design for docs and developer portal
      • Including general elevation improvements
        • How to use tags
        • How can we improve search
        • Separating some of the eng-written docs into their type (there are often mixes of explanations & howtos)
      • Put a design request through for developer portal
    • Begin getting-started audit (dappadan, Cat to meet on August 12th)
    • Have a better process in place for understanding analytics and meeting our KPIs
    • Restructure docs into the new structure
    • Start looking into better reference docs
  • Weeks 3-4 (August 15-28):
    • Continue rewriting reference docs
    • Get back getting-started audit by dappadan
    • Make a detailed plan for what dappadan found & identified gaps
      • Start implementing
    • Get back design for developer portal
      • Find contractor to implement this (to be finished by mid September)
    • Redo Learn/Concepts section and figure out what diagrams we need
      • Put in design request
  • Weeks 5-6 (August 29 - September 11):
    • Diagrams for improved Learn/Concepts section
      • Improve section completely - should be a flow for both devs & non-devs
    • Fill in developer portal & launch it
    • Set up calls with our developers
  • Weeks 7-8 (September 12-25):
    • Internal audits (as a form)
    • We should meet 90% of our KPIs by now
    • Give out grants for 10 people to go through docs - give them different tasks
      • Ensure everything is working and not outdated
      • Ensure it all makes sense
      • Ensure the flow is good
      • Should be complete by end of September
  • Week 9 (September 26-30):
    • Final audit by dappadan (finished by mid October ie offsite)

@catmcgee catmcgee self-assigned this Aug 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant