Top problems we want to solve:
- Documentation, naming, comments are all bad — really hard to understand what is accurate - should be happening in docs
- Onboarding for new developers is really hard, we should design specifications that are developer specific
- Constantly search and find new ways to make the experience of building/onboarding on Lotus and Filecoin better - this should be our main "problem" in 2022
- Short-staffed team: the docs team currently spends about half of its time dealing with community issues, comments, and PRs. The remaining time is split between project management tasks, and then actually creating content. The context switch should be reduced once we onboard
Top-level goals for 2022:
- Facilitate + review the work on overhauling the current Filecoin specification, making it more user friendly
- Enable better user adoption by creating different docs user paths - For example, we should do a breakdown for devs that are working on Filecoin already; a new team that wants to contribute; Web2 devs that want to change sides...
- Increase team size and overall bus factor, since we now only have 1.5 team members. Ideally, we want to scale up to 5 person team for this line of work in 2022
- Make Lotus docs more consumer-friendly - create documentation that will enable new teams building on Lotus to understand what it is and how does it work.
- Make Filecoin docs more accessible by removing code examples, and moving overly technical content away from the front page.
- Enable PL Devs to have easy user flow to publish their doc updates, work together with dev teams to enable this flow + make docs a part of the plans for project deliveries
Work Items For 2022:
- Create an "Informal Specification" for Filecoin development teams, in line with PLv8 changes. Easy to read, easy to understand should be the main theme, so we allow new people that come to check out the project to get a quick understanding of what is going on.
- Polish and maintain "Docs style guide" that will be used for all current and future docs improvements - Define the principles and go for a deep dive across all the different docs sites we have + Make sure we
- Bring in two junior writers to help manage the issues and PRs across the PL docs repos, as well as close easy to medium tasks within those repos.