summaryrefslogtreecommitdiff
path: root/d/quality/tree.txt
blob: 2c238e18d79ec797552babed590dad1ce02f5d92 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
*Title: Arborescence de d�veloppement
*Author: Ni

*TOC

* Partie analogique : |a|

L'arborescence |a| regroupe les d�veloppements concernant les cartes
�lectroniques analogiques. Chaque carte a son r�pertoire ''carte'' contenant :

	[README] qui d�crit la carte ;
	[''carte''.txt] au format AFT qui documente la carte de mani�re plus
	  pr�cise, au niveau utilisation, conception et r�alisation ;
	[''carte''.brd et ''carte''.sch] les fichiers Eagle du circuit
	  imprim�.

Les biblioth�ques Eagle ne sont en g�n�ral pas � mettre dans le r�pertoire de
la carte. Le r�pertoire peut contenir des fichiers suppl�mentaires comme par
exemple les fichiers d'un circuit imprim� d'adaptateur.

Exemple :

^<<
puiss/
  README
  puiss.txt
  puiss.brd
  puiss.sch
^>>

* Partie num�rique : |n|

L'arborescence |n| regroupe les d�veloppements concernant les cartes
�lectroniques num�riques. Chaque carte a son r�pertoire ''carte'' contenant :

	[README] qui d�crit la carte ;
	[pcb/] qui contient le circuit imprim� ;
	[src/] qui contient les sources des programmes concernant la carte.

Le r�pertoire |pcb| contient :

	[''carte''.txt] au format AFT qui documente la carte de mani�re plus
	  pr�cise, au niveau utilisation, conception et r�alisation ;
	[''carte''.brd et ''carte''.sch] les fichiers Eagle du circuit
	  imprim�.

Le r�pertoire |src| contient :

	[''carte''.txt ou ''logiciel''.txt] au format AFT qui documente le
	  code de mani�re plus pr�cise, au niveau utilisation et conception ;
	[les sources] C ou Verilog par exemple, avec le Makefile qui permet de
	  les compiler et les programmes de test ou testbench.

Le r�pertoire |src| peut �tre sous-divis� en plusieurs r�pertoires pour chaque
solution logicielle, si par exemple il y a plusieurs composant � programmer,
des programmes qui tournent sur PC ou diff�rents programmes pour le m�me
composant.

Exemple :

^<<
asserv/
  README
  pcb/
    asserv.brd
    asserv.sch
    adapt.brd
    adapt.sch
  src/
    qdecod/
      Makefile
      qdecod.txt
      qdecod.v
      ...
    asserv/
      Makefile
      asserv.txt
      asserv.c
      ...
^>>

Cette arborescence contient aussi |avr_modules| pour les modules AVR.

* Partie informatique : |i|

L'arborescence |i| regroupe les d�veloppements informatiques. Chaque programme
a son r�pertoire avec au minimum son fichier |README|. Le reste de
l'arborescence varie selon les projets.

* Partie m�canique : |m|

L'arborescence |m| regroupe les d�veloppements m�caniques.

TODO: A compl�ter.

* Outils et m�thodes de d�veloppement : |d|

L'arborescence |d| contient les outils et les m�thodes utilis�s pour
d�velopper le robot. Il contient entre autre :

	[sys] pour le serveur de d�veloppement, son utilisation, ses scripts,
	  sa page web, etc.
	[tools] qui contient des outils de d�veloppement, des scripts, des
	  fichiers de configuration, des manuels, etc.
	[quality] qui contient les documents relatifs � l'assurance qualit�
	  (standards, faq, check-lists...).

* Management de projet : |p|

L'arborescence |p| contient les documents produit de la gestion de projet
ainsi que ceux expliquant son fonctionnement. On y trouve notament :

	[doc] qui explique comment la gestion de projet fonctionne ;
	[reu] avec le compte rendu des r�unions ;
	[todo] avec la todolist et le bugtracking ;
	[reports] avec les rapports hebdo des d�veloppeurs.

* Bureau de l'association : |b|

L'arborescence |b| appartient au bureau de l'association et regroupe les
documents qui n'ont pas de rapport avec le d�veloppement. On y trouve aussi
la liste des membres avec leur r�les, leur pseudo et leur coordonn�es. Ce
n'est donc pas la peine de pr�ciser les coordonn�es de l'auteur dans chaque
document.

* Arborescence Subversion

L'arborescence subversion se trouve dans |/svn|. La racine contient trois
r�pertoires : |trunk|, |tags| et |branches| comme pr�conis� par le manuel de
Subversion. Ces trois r�pertoires sont tous structur�s selon la m�me
arborescence.

Il y a aussi une arborescence |/svntest| pour ceux qui ne connaissent pas
bien Subversion et qui voudraient faire des test.

* Le fichier |README|

Ce fichier doit contenir, sur la premiere ligne le nom du projet (programme ou
carte), suivit d'un tiret et d'une description succinte. Par exemple :

^<<
asserv - Asservissement de position et de vitesse sur AVR.
^>>

Cette ligne sera automatiquement ins�r�e dans les codes sources (voir
|d/quality/code/standards|.

Il doit ensuite contenir une description plus d�taill�e, et la licence de la
carte ou du programme, c'est � dire la GPL, sous la forme :

^<<
Copyright (C) <ann�e> <auteur>

Robot APB Team/Efrei 2005.
       Web: http://assos.efrei.fr/robot/
     Email: robot AT efrei DOT fr

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
^>>