Sign in with Facebook
more photos (1)
Alejandra Quetzalli’s Followers (6)
1,502 books
|
2,839 friends
3,063 books
|
481 friends
2,607 books
|
105 friends
10,701 books
|
4,988 friends
482 books
|
60 friends
3,369 books
|
1,835 friends
224 books
|
1,247 friends
911 books
|
29 friends
More friends…
Alejandra Quetzalli
Goodreads Author
Born
Mexico
Website
Twitter
Genre
Influences
Member Since
August 2012
URL
https://www.goodreads.com/alejandra-quetzalli
To ask
Alejandra Quetzalli
questions,
please sign up.
Popular Answered Questions
Alejandra Quetzalli
I step away and train outside with my dogs in our fav sports and tricks. Fresh air and exercise always help unblock me!
|
Docs-as-Ecosystem: The Community Approach to Engineering Documentation
|
|
* Note: these are all the books on Goodreads for this author. To add more, click here.
“WHY COMMUNITY IS MORE REPRESENTATIVE THAN “USERS”
In the traditional software development model, we're used to writing technical documentation with a specific user in mind. However, this approach can be limiting because it assumes a single "ideal" user represents your entire user base.
The docs-as-ecosystem model proposes a different way of thinking about technical documentation; it recognizes technical documentation is not just a product but an ongoing conversation between diverse documentation creators (contributors) and the community.
Thinking in terms of community has several advantages over focusing only on users:
More inclusive: Focusing on the community is more inclusive than focusing only on users because it recognizes that many different types of stakeholders contribute to and read the documentation.
More diverse: Focusing on the community encourages diversity and inclusion because it recognizes many different backgrounds and experiences.
More collaborative: Focusing on the community also fosters a more collaborative approach to documentation because it encourages anyone from any background to participate.
By focusing on community, the docs-as-ecosystem approach offers a more flexible, adaptable, and sustainable way to approach technical documentation. Rather than assuming that there is a single "ideal" user, we recognize that technical documentation is a dynamic and ongoing conversation between documentation creators and the community.”
― Docs-as-Ecosystem: The Community Approach to Engineering Documentation
In the traditional software development model, we're used to writing technical documentation with a specific user in mind. However, this approach can be limiting because it assumes a single "ideal" user represents your entire user base.
The docs-as-ecosystem model proposes a different way of thinking about technical documentation; it recognizes technical documentation is not just a product but an ongoing conversation between diverse documentation creators (contributors) and the community.
Thinking in terms of community has several advantages over focusing only on users:
More inclusive: Focusing on the community is more inclusive than focusing only on users because it recognizes that many different types of stakeholders contribute to and read the documentation.
More diverse: Focusing on the community encourages diversity and inclusion because it recognizes many different backgrounds and experiences.
More collaborative: Focusing on the community also fosters a more collaborative approach to documentation because it encourages anyone from any background to participate.
By focusing on community, the docs-as-ecosystem approach offers a more flexible, adaptable, and sustainable way to approach technical documentation. Rather than assuming that there is a single "ideal" user, we recognize that technical documentation is a dynamic and ongoing conversation between documentation creators and the community.”
― Docs-as-Ecosystem: The Community Approach to Engineering Documentation
“Here are some reasons for the software developer community to adopt "docs-as-ecosystem":
Proposes a more holistic 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.
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.
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.”
― Docs-as-Ecosystem: The Community Approach to Engineering Documentation
Proposes a more holistic 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.
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.
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.”
― Docs-as-Ecosystem: The Community Approach to Engineering Documentation
“The docs-as-ecosystem model starts with community feedback (A), captured through various channels such as public GitHub discussions, public surveys, forums, social media, and support requests. This feedback is then incorporated into the documentation codebase, which is managed through version control (B) to ensure that all changes are tracked and reviewed.
The documentation codebase is then integrated continuously (C) through a continuous integration process, which helps catch errors and ensure that documentation updates are consistent with the rest of the codebase. The codebase is then used to generate static site documentation (D), the basis for the final generated documentation (E).
The generated documentation is then published (F) to a production environment, where it’s accessible to the community. Finally, the community can review the results and provide updated feedback on the published documentation (H), which starts the cycle anew.
Incorporating community feedback ensures documentation remains up-to-date and accurate, reflecting the needs and concerns of the community. Building stronger relationships between community and documentation creation processes lead to engaged and thriving communities.”
― Docs-as-Ecosystem: The Community Approach to Engineering Documentation
The documentation codebase is then integrated continuously (C) through a continuous integration process, which helps catch errors and ensure that documentation updates are consistent with the rest of the codebase. The codebase is then used to generate static site documentation (D), the basis for the final generated documentation (E).
The generated documentation is then published (F) to a production environment, where it’s accessible to the community. Finally, the community can review the results and provide updated feedback on the published documentation (H), which starts the cycle anew.
Incorporating community feedback ensures documentation remains up-to-date and accurate, reflecting the needs and concerns of the community. Building stronger relationships between community and documentation creation processes lead to engaged and thriving communities.”
― Docs-as-Ecosystem: The Community Approach to Engineering Documentation
“Here are some reasons for the software developer community to adopt "docs-as-ecosystem":
Proposes a more holistic 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.
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.
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.”
― Docs-as-Ecosystem: The Community Approach to Engineering Documentation
Proposes a more holistic 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.
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.
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.”
― Docs-as-Ecosystem: The Community Approach to Engineering Documentation
“The docs-as-ecosystem model starts with community feedback (A), captured through various channels such as public GitHub discussions, public surveys, forums, social media, and support requests. This feedback is then incorporated into the documentation codebase, which is managed through version control (B) to ensure that all changes are tracked and reviewed.
The documentation codebase is then integrated continuously (C) through a continuous integration process, which helps catch errors and ensure that documentation updates are consistent with the rest of the codebase. The codebase is then used to generate static site documentation (D), the basis for the final generated documentation (E).
The generated documentation is then published (F) to a production environment, where it’s accessible to the community. Finally, the community can review the results and provide updated feedback on the published documentation (H), which starts the cycle anew.
Incorporating community feedback ensures documentation remains up-to-date and accurate, reflecting the needs and concerns of the community. Building stronger relationships between community and documentation creation processes lead to engaged and thriving communities.”
― Docs-as-Ecosystem: The Community Approach to Engineering Documentation
The documentation codebase is then integrated continuously (C) through a continuous integration process, which helps catch errors and ensure that documentation updates are consistent with the rest of the codebase. The codebase is then used to generate static site documentation (D), the basis for the final generated documentation (E).
The generated documentation is then published (F) to a production environment, where it’s accessible to the community. Finally, the community can review the results and provide updated feedback on the published documentation (H), which starts the cycle anew.
Incorporating community feedback ensures documentation remains up-to-date and accurate, reflecting the needs and concerns of the community. Building stronger relationships between community and documentation creation processes lead to engaged and thriving communities.”
― Docs-as-Ecosystem: The Community Approach to Engineering Documentation
“WHY COMMUNITY IS MORE REPRESENTATIVE THAN “USERS”
In the traditional software development model, we're used to writing technical documentation with a specific user in mind. However, this approach can be limiting because it assumes a single "ideal" user represents your entire user base.
The docs-as-ecosystem model proposes a different way of thinking about technical documentation; it recognizes technical documentation is not just a product but an ongoing conversation between diverse documentation creators (contributors) and the community.
Thinking in terms of community has several advantages over focusing only on users:
More inclusive: Focusing on the community is more inclusive than focusing only on users because it recognizes that many different types of stakeholders contribute to and read the documentation.
More diverse: Focusing on the community encourages diversity and inclusion because it recognizes many different backgrounds and experiences.
More collaborative: Focusing on the community also fosters a more collaborative approach to documentation because it encourages anyone from any background to participate.
By focusing on community, the docs-as-ecosystem approach offers a more flexible, adaptable, and sustainable way to approach technical documentation. Rather than assuming that there is a single "ideal" user, we recognize that technical documentation is a dynamic and ongoing conversation between documentation creators and the community.”
― Docs-as-Ecosystem: The Community Approach to Engineering Documentation
In the traditional software development model, we're used to writing technical documentation with a specific user in mind. However, this approach can be limiting because it assumes a single "ideal" user represents your entire user base.
The docs-as-ecosystem model proposes a different way of thinking about technical documentation; it recognizes technical documentation is not just a product but an ongoing conversation between diverse documentation creators (contributors) and the community.
Thinking in terms of community has several advantages over focusing only on users:
More inclusive: Focusing on the community is more inclusive than focusing only on users because it recognizes that many different types of stakeholders contribute to and read the documentation.
More diverse: Focusing on the community encourages diversity and inclusion because it recognizes many different backgrounds and experiences.
More collaborative: Focusing on the community also fosters a more collaborative approach to documentation because it encourages anyone from any background to participate.
By focusing on community, the docs-as-ecosystem approach offers a more flexible, adaptable, and sustainable way to approach technical documentation. Rather than assuming that there is a single "ideal" user, we recognize that technical documentation is a dynamic and ongoing conversation between documentation creators and the community.”
― Docs-as-Ecosystem: The Community Approach to Engineering Documentation
Goodreads Librarians Group
— 297162 members
— last activity 0 minutes ago
Goodreads Librarians are volunteers who help ensure the accuracy of information about books and authors in the Goodreads' catalog. The Goodreads Libra ...more
