URL https://opencores.org/ocsvn/socgen/socgen/trunk

Subversion Repositories socgen

[/] [socgen/] [trunk/] [doc/] [src/] [guides/] [guide_documentation.html] - Blame information for rev 65

Go to most recent revision | Details | Compare with Previous | View Log


<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
  <meta http-equiv="CONTENT-TYPE" content="text/html; charset=UTF-8">
  <title>Documentation Guidelines</title>
  <meta name="GENERATOR" content="OpenOffice.org 3.0  (Linux)">
  <meta name="CREATED" content="0;0">
  <meta name="CHANGED" content="20100309;9322200">
  <meta name="KEYWORDS" content="start">
  <meta name="Info 3" content="">
  <meta name="Info 4" content="">
  <meta name="date" content="2008-01-08T12:01:41-0500">
  <meta name="robots" content="index,follow">
</head>
<body dir="LTR" lang="en-US">
<div id="toc__header" dir="LTR">
<p><br>
<br>
</p>
</div>
<h1><a name="socgen_project"></a>SOCGEN Project</h1>
<h2><a name="manifesto"></a>Documentation Guidelines</h2>
<p><br>
<br>
</p>
<p>Every component must include a minimum set of documents. This
consists of a ./doc directory that contains a html file named
"index.html".&nbsp; This file is the link that all external users will
use to access each components documents.&nbsp; Those documents consist
of:<br>
</p>
<p><br>
</p>
<ul>
  <li>A Socgen datasheet for the component and each of it's variants</li>
  <li>Application notes detailing how to use the component.</li>
  <li>Any 3rd party produced reference material needed to support the
component</li>
  <li>Test plans detailing how the component rtl was simulated and what
was tested.<br>
  </li>
  <li>Test plans detailing how to synthesis the component and prove
functionality in silicon. <br>
  </li>
</ul>
<p><br>
<br>
</p>
<p>All documentation source will be stored as html files. A pdf will be
extractred from each source and also included. <br>
</p>
<p><br>
</p>
<p><br>
<span style="font-weight: bold;"></span></p>
<h2><a name="manifesto"></a>Tool support for documentation creation</h2>
<br>
The Socgen project uses and supports three opensourced tools for
creating and maintaining component documentation. The key to accurate
and timely documents is to automate their creation as part of the IP
build process.<br>
<br>
<br>
<br>
SEAMONKEY<br>
<br>
Seamonkey composer is the main tool used to edit the html files.<br>
<br>
<br>
GSCHEM<br>
<br>
Geda and friends are used to create any and all graphics used in the
html files. Several support tools are provided that can extract
schematic and symbol information directly from the database ensuring
that the database and documents stay in sync <br>
<br>
<br>
OPENOFFICE WORD PROCESSOR<br>
<br>
Is used to create the pdf for each component <br>
<br>
<p><br>
<br>
</p>
<p><br>
<img style="width: 800px; height: 600px;" alt=""
 src="../png/doc_fig1.png"><br>
</p>
<p><br>
<br>
</p>
<p><br>
<br>
</p>
<p><br>
<br>
</p>
<p><br>
<br>
</p>
<p><br>
<br>
</p>
<p><br>
<br>
</p>
<p><br>
<br>
</p>
<p><br>
<br>
</p>
<p><br>
<br>
</p>
<p><br>
<br>
</p>
<p><br>
<br>
</p>
<p><br>
<br>
</p>
<p><br>
<br>
</p>
<p><br>
<br>
</p>
<p><br>
<br>
</p>
<p><br>
<br>
</p>
</body>
</html>

Line No.	Rev	Author	Line
1	20	jt_eaton	`<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">`
2			`<html>`
3			`<head>`
4			`<meta http-equiv="CONTENT-TYPE" content="text/html; charset=UTF-8">`
5	27	jt_eaton	`<title>Documentation Guidelines</title>`
6	20	jt_eaton	`<meta name="GENERATOR" content="OpenOffice.org 3.0 (Linux)">`
7			`<meta name="CREATED" content="0;0">`
8			`<meta name="CHANGED" content="20100309;9322200">`
9			`<meta name="KEYWORDS" content="start">`
10			`<meta name="Info 3" content="">`
11			`<meta name="Info 4" content="">`
12			`<meta name="date" content="2008-01-08T12:01:41-0500">`
13			`<meta name="robots" content="index,follow">`
14			`</head>`
15			`<body dir="LTR" lang="en-US">`
16			`<div id="toc__header" dir="LTR">`
17			`<p><br>`
18			`<br>`
19			`</p>`
20			`</div>`
21			`<h1><a name="socgen_project"></a>SOCGEN Project</h1>`
22			`<h2><a name="manifesto"></a>Documentation Guidelines</h2>`
23			`<p><br>`
24			`<br>`
25			`</p>`
26			`<p>Every component must include a minimum set of documents. This`
27			`consists of a ./doc directory that contains a html file named`
28			`"index.html".  This file is the link that all external users will`
29			`use to access each components documents.  Those documents consist`
30			`of:<br>`
31			`</p>`
32			`<p><br>`
33			`</p>`
34			`<ul>`
35			`<li>A Socgen datasheet for the component and each of it's variants</li>`
36			`<li>Application notes detailing how to use the component.</li>`
37			`<li>Any 3rd party produced reference material needed to support the`
38			`component</li>`
39			`<li>Test plans detailing how the component rtl was simulated and what`
40			`was tested.<br>`
41			`</li>`
42			`<li>Test plans detailing how to synthesis the component and prove`
43			`functionality in silicon. <br>`
44			`</li>`
45			`</ul>`
46			`<p><br>`
47			`<br>`
48			`</p>`
49			`<p>All documentation source will be stored as html files. A pdf will be`
50			`extractred from each source and also included. <br>`
51			`</p>`
52			`<p><br>`
53			`</p>`
54			`<p><br>`
55			`<span style="font-weight: bold;"></span></p>`
56			`<h2><a name="manifesto"></a>Tool support for documentation creation</h2>`
57			`<br>`
58			`The Socgen project uses and supports three opensourced tools for`
59			`creating and maintaining component documentation. The key to accurate`
60			`and timely documents is to automate their creation as part of the IP`
61			`build process.<br>`
62			`<br>`
63			`<br>`
64			`<br>`
65			`SEAMONKEY<br>`
66			`<br>`
67			`Seamonkey composer is the main tool used to edit the html files.<br>`
68			`<br>`
69			`<br>`
70			`GSCHEM<br>`
71			`<br>`
72			`Geda and friends are used to create any and all graphics used in the`
73			`html files. Several support tools are provided that can extract`
74			`schematic and symbol information directly from the database ensuring`
75			`that the database and documents stay in sync <br>`
76			`<br>`
77			`<br>`
78			`OPENOFFICE WORD PROCESSOR<br>`
79			`<br>`
80			`Is used to create the pdf for each component <br>`
81			`<br>`
82			`<p><br>`
83			`<br>`
84			`</p>`
85			`<p><br>`
86			`<img style="width: 800px; height: 600px;" alt=""`
87			`src="../png/doc_fig1.png"><br>`
88			`</p>`
89			`<p><br>`
90			`<br>`
91			`</p>`
92			`<p><br>`
93			`<br>`
94			`</p>`
95			`<p><br>`
96			`<br>`
97			`</p>`
98			`<p><br>`
99			`<br>`
100			`</p>`
101			`<p><br>`
102			`<br>`
103			`</p>`
104			`<p><br>`
105			`<br>`
106			`</p>`
107			`<p><br>`
108			`<br>`
109			`</p>`
110			`<p><br>`
111			`<br>`
112			`</p>`
113			`<p><br>`
114			`<br>`
115			`</p>`
116			`<p><br>`
117			`<br>`
118			`</p>`
119			`<p><br>`
120			`<br>`
121			`</p>`
122			`<p><br>`
123			`<br>`
124			`</p>`
125			`<p><br>`
126			`<br>`
127			`</p>`
128			`<p><br>`
129			`<br>`
130			`</p>`
131			`<p><br>`
132			`<br>`
133			`</p>`
134			`<p><br>`
135			`<br>`
136			`</p>`
137			`</body>`
138			`</html>`

Browse

Tools

Subversion Repositories socgen

[/] [socgen/] [trunk/] [doc/] [src/] [guides/] [guide_documentation.html] - Blame information for rev 65