w3c / w3c/editing

[charter] describe deliverables

Open
#294 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
202
Forks
43
PR merge metrics
No merged PRs in 30d

Description

I'm used to seeing the list of deliverables in charters include a brief summary of each document, e.g. stolen from the doc's abstract. I particularly note the lack of that in the "Other Deliverables" section, where we don't have links to the documents.

I'm also aware that our charters are too wordy to begin with. Up to you whether to fix that for the existing deliverables, but I do think more words are needed for the "other deliverables", unless you have links available for not-yet-adopted proposed docs.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the editing charters and review the Deliverables and Other Deliverables sections. Compare their entries with available document abstracts or links, then update the descriptions so each deliverable has an appropriate brief summary and unadopted documents are linked when possible. Done means the sections clearly describe their listed deliverables without unnecessary expansion.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.