Git Product home page Git Product logo

nodejsbook.io.examples's Introduction

Created docs-as-ecosystem model & published author (2023)

Visit the docs-as-ecosystem book website; my book is available in B&N, Amazon, and independent book stores.

Quetzalli's approach to engineering documentation inspired her to coin the new term "docs-as-ecosystem."

She believes that "docs-as-ecosystem" represents a more comprehensive and collaborative approach to documentation development than "docs-as-code" because it recognizes that documentation is more than just code. Docs involve technical writing, design, community feedback, community management, accessibility, SEO, UX, and today… even Artificial Intelligence tools! The word ecosystem promotes a paradigm where documentation is treated as a complex and dynamic system that must be managed and nurtured.

Here are some reasons for software communities to adopt the "docs-as-ecosystem" model:

  1. Proposes a holistic, multidisciplinary, and community-centered approach: The term "docs-as-ecosystem" recognizes that documentation is not just a set of markdown files or code snippets but an ecosystem that needs to be managed and nurtured. The term "docs-as-code" has been widely adopted recently, but it may not fully capture the complexity and diversity of documentation development. The term "docs-as-ecosystem" aligns with the industry trend towards a more holistic and community-centered approach to documentation development.
  2. Encourages collaboration: The term "docs-as-ecosystem" acknowledges that documentation development involves different roles and stakeholders, such as technical writers, designers, developers, community members, and beyond. By adopting this term, the software developer community can encourage collaboration across diverse stakeholders and facilitate the creation of high-quality documentation.
  3. Emphasizes the importance of retrieving and incorporating community feedback: The term "docs-as-ecosystem" highlights the importance of retrieving and integrating community feedback in documentation development. It recognizes that documentation is about providing information and meeting community needs and preferences.

What I do for AsyncAPI Docs and the OSS Community ✨✨

  • Oversee the management of technical writing budgets for the AsyncAPI Docs and Education projects.
  • Led hiring efforts for the AsyncAPI Docs and Education projects, significantly enhancing the documentation team/contributors.
  • Mentored and managed six direct report contract technical writers for Google Season of Docs (GSoD) 2022, resulting in two mentees becoming core contributors to AsyncAPI.
  • Successfully raised over $20,000 in GSoD grant money for AsyncAPI docs contributors.
  • Collaborate with the community to revise the information architecture of AsyncAPI docs, integrating new content buckets to enrich our API documentation.
  • Pioneer efforts in aligning the necessary changes for the upcoming Spec 3.0 release of AsyncAPI docs.
  • Advocate for including interactive content and learning paths in the AsyncAPI documentation.
  • Expand the AsyncAPI docs community by initiating public discussions, community votes, and by establishing the #13_docs channel on Slack.

nodejsbook.io.examples's People

Contributors

shapeshed avatar svnlto avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.