Re: [Qscada-developers] Document templates

[wireless <wir...@ta...>]

Jovan Kostovski wrote:
> Hi all,
> 
> As we said, we need some templates for the documents.
> 
> What kind of templates do we need?
> 1. Source code templates
> 2. Document templates for documentation, propositions etc.
> ...
> ...
> 
> 
> Which parts should we discuss about the document structure
> 
> 1. Sources:
>     - header comment
>              - filename
>              - description
>              - author ?? ((we'll probably put Paolo's name here, as he
> is the project leader)
>              - revision history
>              - license
>     - code formatting
>     - naming conventions
>     ...
>     ...
>     ...
> 
> 2. General Document contents:
>    - front page layout
>    - table of contents
>    - header
>    -  footer
>    - fonts to be used ??
>    - pictures / diagrams which programs to use for creating them
>   ...
>   ...
>   ...
> 
> Ideas/ Suggestions ???
> 
> 
> GREETZ, Jovan


That looks like a hell of a start.   Pick an example or 2 and each
time we create or modify a document, we can extend the template if
needed.


The first page should be the same with just the differences in the
unique information.   Look at the RFC's as they are fine for documents
that need content. But if you guys are going to publish the web, and
make some live with revision history, then an XML file might be better?

In summary, just pick a document or 2, edit them and we'll start
there. You know how some wiki's can be edited by users, what about
that sort of format? Maybe visitors or new members only get read
permission and the devs get read/write?

I'm not so hung up on the perfect document, as that will happen over
time. I just think we need to get the templates up and agree who gets
read/write privileges. The group is small right now, so who ever comes
up with something, is the team leader for that issue(doc)  or piece of
code.


What about CVS vs SVN?  Did we ever decide on that?


James