├── README.md └── docs-cg.md /README.md: -------------------------------------------------------------------------------- 1 | # charter-proposals 2 | Repo to host discussions and iterations on possible charters for Community Groups 3 | -------------------------------------------------------------------------------- /docs-cg.md: -------------------------------------------------------------------------------- 1 | # W3C Documentation CG Charter 2 | 3 | ## Mission 4 | 5 | The mission of the W3C Documentation Community Group (W3C Docs CG) is to ensure web developers and designers worldwide have the best information available so they can build things on the web platform. 6 | 7 | ## Scope of work 8 | 9 | This community group will: 10 | 11 | - Plan and write new documentation for web platform technologies. 12 | - Make sure reference documentation (“the book of web platform features”) is complete. 13 | - Identify needs for guides, how-tos, and tutorials, and create them. 14 | - Work with specification authors to define best practices for web developer documentation, code examples, and information architecture. 15 | - Maintain and keep documentation up-to-date using modern approaches like docs-as-code 16 | - Develop tools to create feedback loops between standards and web developer documentation. 17 | - Coordinate documentation efforts: Collaborate with other W3C community groups, such as [WebDX](https://www.w3.org/community/webdx/), [Security](https://www.w3.org/mission/security/), [Privacy](https://www.w3.org/mission/privacy/), [Accessibility](https://www.w3.org/mission/accessibility/), [Internationalization](https://www.w3.org/mission/internationalization/), [Sustainability](https://www.w3.org/community/sustyweb/) and integrate their findings and best practices into documentation. 18 | - Be a resource for resources: map documentation sources for web developers. 19 | - Identify reliable sources of information. 20 | - Invite them to be part of the conversations in this community group. 21 | - Drive adoption (or deprecation) of web platform technologies: 22 | - Identify web platform features where sparse docs prevent adoption and understanding. 23 | - Interpret developer surveys (such as the [MDN short survey on web developer’s experience with Web Security](https://github.com/web-platform-dx/developer-research/blob/main/mdn-short-surveys/2023-05-15-security-dx/interpretation.md) and understand the role of documentation in identified shortcomings. 24 | - Ensure documentation relevance: coordinate horizontal efforts to get outdated docs updated such as by helping reach out to the right docs owners. 25 | - Be a hub for web documentation: when docs-related efforts, changes, and/or projects appear, coordinate with the relevant stakeholders to get these amplified. 26 | 27 | ## Key deliverables 28 | 29 | - Write and maintain docs in [mdn/content](https://github.com/mdn/content). See the [backlog](https://openwebdocs.github.io/web-docs-backlog/) for missing reference pages. 30 | - Identify best practices for web developer documentation. 31 | - Drive adoption and understanding of web technologies. 32 | 33 | ## Out of scope 34 | 35 | The group may produce Community Group Reports within the scope of this charter but not Specifications. 36 | 37 | ## Dependencies or liaisons 38 | 39 | - Groups 40 | - [Open Web Docs](https://openwebdocs.org) 41 | - [Web Developer Experience (WebDX) Community Group](https://www.w3.org/community/webdx/) 42 | - [Webref & spec tooling maintainers](https://www.w3.org/community/speced-cg/) 43 | - [SWAG Community Group](https://www.w3.org/community/swag/) 44 | - [TAG](https://www.w3.org/2001/tag/) (especially related to “explainers”) 45 | - [OWASP](https://owasp.org) docs 46 | - [OSTIF](https://ostif.org/) 47 | - [Write The Docs](https://www.writethedocs.org) community 48 | - [ARIA Practices Guide Taskforce](https://www.w3.org/WAI/about/groups/task-forces/practices/) (a subgroup of ARIA WG) who owns/maintains [APG](https://www.w3.org/WAI/ARIA/apg/). 49 | - Docs sites 50 | - [MDN Web Docs](https://developer.mozilla.org) 51 | - [CanIUse](https://caniuse.com) 52 | - [web.dev](https://web.dev) 53 | - [learn.microsoft.com](https://learn.microsoft.com) 54 | - [devdocs.io](https://devdocs.io) 55 | - [Freecodecamp](https://www.freecodecamp.org) 56 | - Popular front-end sites/blogs which also document the web, for example: [css-tricks.com](https://css-tricks.com/almanac/pseudo-selectors/), [w3schools](https://www.w3schools.com), ... 57 | - Translated docs, for example: [Doka: web docs for Russian speaking developers](https://doka.guide/) 58 | 59 | ## Audience 60 | 61 | Who is this CG for? 62 | 63 | - Technical writers and other documentation practitioners to collaborate. 64 | - Web platform docs sites to share best practices. 65 | - Specification authors and implementers to give and receive feedback on documentation and specs. 66 | - Web developers to identify and request support to better the understanding of web platform technologies. 67 | --------------------------------------------------------------------------------