- From: Chris Mills <chris@millsdocs.com>
- Date: Fri, 22 Nov 2024 12:51:51 +0000
- To: public-sccg@w3.org
- Message-Id: <8B4C4A3B-FDFC-487B-842E-D8132EBAA7E2@millsdocs.com>
Hi Screen Capture CG! I’m Chris Mills, formerly of Opera and Mozilla; these days I run a technical writing consultancy, mainly documenting web technologies on MDN for Google and Mozilla. One of my latest tasks for Google is documenting the Region and Element Capture APIs, and I’m thinking about how best to structure the reference docs. It makes sense for them to live next to the existing Screen Capture API docs. The trouble with MDN is that we tend to split API ref docs up by API spec, rather than by functionality. Putting Region and Element Capture inside Screen Capture wouldn’t work on MDN; the natural way to do it would be a separate docs tree for each API. However, I don’t really want to do that, as both of them use nearly the same API surfaces, they are very closely related, and each tree would be tiny. I think it would be a better user experience to invent a collective term for these kinds of API and have one landing page for that, which they (and future similar APIs) can live under. François and I have been discussing “Screen Capture extensions” as a collective term that they could live under. I think its suitability depends on what future APIs you have got in the pipeline, and how many. We also don’t want this collective docs tree to end up as a dumping ground for loads of stuff. What do you folks think? Best regards, Chris Mills Director and Lead Technical Writer Mills Docs Limited <https://millsdocs.com/> chris@millsdocs.com LinkedIn <https://www.linkedin.com/in/chris-mills-4471711/> / Twitter <https://twitter.com/chrisdavidmills>
Received on Friday, 22 November 2024 13:48:15 UTC