Write documentation for Web Components

[Elchi3]

Problem statement

See w3c-cg/webdocs#1 for a detailed analysis of how web developers understand (or don't understand) Web Components.

Proposed solutions

Write guides, tutorials, how-tos, and clean up reference pages so that it is easier to understand Web Components.

Look at these docs from the perspective of two audiences and provide essentially providing two separate paths for people.

1. people writing custom elements from scratch
2. and people using a library like Lit.

Task list

• Create a content outline for this project. See https://github.com/webcomponents-cg/docs-and-guides/blob/main/plan/outline.md for a start. It should take into account the two audiences as well as respond to the educational gaps the surveys identified.
• Write the content
• Re-survey and/or user interview web developers.

Priority assessment

• Effort:
• Dependencies:
• Community enablement:
• Momentum:
• Enabling learners:
• Enabling professionals:
• Underrepresented topics / Ethical web:
• Operational necessities:
• Addressing needs of the web industry:

More information

Open Web Docs (OWD) is a non-profit collective funded by corporate and individual donations.

In order for this project to happen, please consider donating to OWD at https://opencollective.com/open-web-docs.
For more information on sponsorship and membership tiers, see https://openwebdocs.org/membership/

More information is available at https://openwebdocs.org/.
For questions, please reach out to florian@openwebdocs.org.