[Open-graphics] OGPN12 newsletter draft and writing drivers
Jack Carroll
mykrowatt at comcast.net
Sun Oct 22 18:52:02 EDT 2006
On Fri, Oct 20, 2006 at 08:49:08PM +0200, Lourens Veen wrote:
>
> Amen. Could we perhaps aspire to create some decent overview-type
> documentation to everything we produce? So that new developers can join
> in more easily?
I make that a standard practice in hardware design. In addition to
the schematic, assemble drawing, and parts list, I write a document called a
"Technical Reference". It's a written explanation of how the product works,
and the reasons for the less obvious design decisions. It often includes
key design calculations. It's meant to help engineering technicians, test
engineers, and design engineers who come along later and need to update the
design. The combination of the schematic and the tech ref amount to a
technical manual for the product.
More information about the Open-graphics
mailing list