33 ms·

Does anyone know where to find real examples of design docs, possibly following this guide? I don't mean toy examples but something that's actually used by real

Does anyone know where to find real examples of design docs, possibly following this guide? I don't mean toy examples but something that's actually used by real people/orgs. My workplace has design docs but they're full of made-up words, so I'm pretty burned out by this kind of thing.

Offpics 6y ago
Deno design doc for example https://docs.google.com/document/u/0/d/1_WvwHl7BXUPmoiSeD8G83JmS8ypsTPqed4Btkqkn_-4/mobilebasic https://docs.google.com/document/u/0/d/1_WvwHl7BXUPmoiSeD8G8...
- PascLeRasc 6y ago
  Thanks! That was interesting to read and gives me hope for a better workplace. So it's basically a much more thought-out Github issue/corresponding PR, would you agree?
yegle 6y ago
The author of Beancount (a text based accounting software) is a Googler and he recently shared https://docs.google.com/document/d/1qPdNXaz5zuDQ8M9uoZFyyFis7hA0G55BEfhWhrVBsfc/edit?usp=drivesdk https://docs.google.com/document/d/1qPdNXaz5zuDQ8M9uoZFyyFis... which is a pretty standard Google style design doc.
vially 6y ago
This is one I follow related to adding multi-window support to Flutter: https://flutter.dev/go/desktop-multi-window-support https://flutter.dev/go/desktop-multi-window-support I also found some of the chromium design docs quite interesting: https://www.chromium.org/developers/design-documents https://www.chromium.org/developers/design-documents
cpeterso 6y ago
Python's PEPs (Python Enhancement Proposals) are pretty good examples of design docs that describe the problem, proposed solution, and rationale: https://www.python.org/dev/peps/ https://www.python.org/dev/peps/
mbakke 6y ago
I've been a long-time user of a Google virtualization toolkit that was developed in the open. It is full of such design docs: http://docs.ganeti.org/ganeti/master/html/#implemented-designs http://docs.ganeti.org/ganeti/master/html/#implemented-desig... As an end user I always enjoyed reading those.
fomine3 6y ago
IIRC I saw it on leaked docs by Veritas

Offpics 6y ago

Deno design doc for example https://docs.google.com/document/u/0/d/1_WvwHl7BXUPmoiSeD8G83JmS8ypsTPqed4Btkqkn_-4/mobilebasic https://docs.google.com/document/u/0/d/1_WvwHl7BXUPmoiSeD8G8...

PascLeRasc 6y ago
Thanks! That was interesting to read and gives me hope for a better workplace. So it's basically a much more thought-out Github issue/corresponding PR, would you agree?

yegle 6y ago

The author of Beancount (a text based accounting software) is a Googler and he recently shared https://docs.google.com/document/d/1qPdNXaz5zuDQ8M9uoZFyyFis7hA0G55BEfhWhrVBsfc/edit?usp=drivesdk https://docs.google.com/document/d/1qPdNXaz5zuDQ8M9uoZFyyFis... which is a pretty standard Google style design doc.

vially 6y ago

This is one I follow related to adding multi-window support to Flutter: https://flutter.dev/go/desktop-multi-window-support https://flutter.dev/go/desktop-multi-window-support I also found some of the chromium design docs quite interesting: https://www.chromium.org/developers/design-documents https://www.chromium.org/developers/design-documents

cpeterso 6y ago

Python's PEPs (Python Enhancement Proposals) are pretty good examples of design docs that describe the problem, proposed solution, and rationale: https://www.python.org/dev/peps/ https://www.python.org/dev/peps/

mbakke 6y ago

I've been a long-time user of a Google virtualization toolkit that was developed in the open. It is full of such design docs: http://docs.ganeti.org/ganeti/master/html/#implemented-designs http://docs.ganeti.org/ganeti/master/html/#implemented-desig... As an end user I always enjoyed reading those.

fomine3 6y ago

IIRC I saw it on leaked docs by Veritas