On 6/11/06, Jack Carroll <[EMAIL PROTECTED]> wrote:
A quick summary of documentation topics jb and I have been
discussing off-list:
BTW, I'm behind in some emails, so I'm sure I should have said
something by now. :)
On Sun, Jun 11, 2006 at 02:12:17AM +1200, josephhenryblack wrote:
> As soon as timothy provides the latest revG schematic, we could start
> documenting something of the 672? pin outs. The hardware programmers
> would appreciate a list of what goes where for when they stop with the
> simulations and assign the pins for real.
> As soon as the new BOM is listed, we want some list references and
> details in the wiki, and this will help with the pin out list.
> Programming in C or.. etc
> I think Jack may soon be looking for a piece of software that will
> generate codes for Traversal or OGP documents. We need to have a way to
> specify different documents like (apologies to Jack) as he described it
> to me like government standards - they have unique numbers and
> references. With our Official OGP documentation we will need to have a
> pattern to differentiate between different types of documents - but we
> want to prevent mistakes, so a piece of software would help so we don't
> need to refresh our memory by going back and reading up on the docs to
> work out what to call the page.
Actually, I'm not looking for a piece of software _at this time_.
I think jb is probably right that a suitable piece of software can help
maintain consistency and reduce duplication when we need to assign document
numbers and stock numbers, but the amount of that kind of work facing us
right now is easy to handle manually.
I noticed that the OGD1 schematic has no drawing number or revision
level. I think the time has come to take care of that detail.
Tim: if you will approve the set of standards I sent you for the
Traversal numbering system (A-100A1, A-100A2, A-100A3) or tell me what needs
to be fixed before they can be approved, jb and I can take the following
actions:
I can't say that those numbers are bad, so let's go with them.
1. Start a blank number log for Traversal root numbers, probably on the
wiki.
2. Fill in the root number for the OGD1 assembly, bare board, and any other
custom parts that require Traversal drawings.
3. Generate drawing numbers according to the numbering system standard, and
send them to you and Howard to fill in on the title blocks.
4. Start a blank number log for OGP standards, specifications, and other
official project documents.
5. Issue the Traversal numbering system standards and post them on-line.
When time permits, convert them to ODF (they won't look as clean, but other
people besides me will be able to revise them).
6. When I get more time, write a much smaller and simpler numbering system
standard for OGP documents.
These sound like great ideas.
I'm pretty well buried right now, with two contract engineering jobs
started up in the last week. So a little clerk-work supporting the
numbering system is about all I can contribute for the foreseeable future.
It's good to see the actual engineering being dealt with so effectively.
Well, without your numbering system, it would eventually fall apart. :)
Regarding which number universe different documents belong in...
OGP documents should describe the graphics architecture, but not a
particular implementation of it. They would cover register layouts, command
sets, technical rationale, application notes, model driver code, and the
like.
Anything related specifically to OGD1, such as the FPGA pinout list,
should be a Traversal document, with a drawing number generated from the
OGD1 root number. The sooner we have an approved standard for the Traversal
drawing number system, the sooner we can identify these revision-controlled
documents.
_______________________________________________
Open-graphics mailing list
[email protected]
http://lists.duskglow.com/mailman/listinfo/open-graphics
List service provided by Duskglow Consulting, LLC (www.duskglow.com)
_______________________________________________
Open-graphics mailing list
[email protected]
http://lists.duskglow.com/mailman/listinfo/open-graphics
List service provided by Duskglow Consulting, LLC (www.duskglow.com)
