Документ взят из кэша поисковой машины. Адрес оригинального документа : http://www.eso.org/projects/dfs/team/templates-list.html
Дата изменения: Tue Apr 19 18:36:05 2005
Дата индексирования: Sun Apr 13 22:49:00 2008
Кодировка:
Поисковые слова: http www.astronomy.ru forum index.php topic 4644.0.html

list of DFS Department documentation templates

DFS Department
Templates for documentation

HOME

INDEX

HELP

NEWS

Templates for source code

Each module of source code should contain a header that defines:

ESO copyright, division, department
Module Name
Author Name
Creation Date
Change History: version, date, author, description (refer to problem report ticket)
Overall module description: say in one sentence what the module does
Interfaces: define every inputs and outputs in terms of: role, type, range of values
Dependencies: describe the preconditions for using this component (imported modules, environment variables, ...)
Processing: summarise the processing using pseudo-code or a pseudo-design language (use the usual control structures provided by the programming language, but normal text or sentences instead of variables names or function calls)

Examples:

Shell module
Python module

The official ESO document template

Any document produced by the DFS Department has to apply the official ESO document template: MSWORD format (ZIP compressed), Latex format as compressed tar file(courtesy of Ralf and Pascal), or StarOffice format.

Templates for DFS documents

Users requirements (WORD, based on ESA standards)
Software Specification (WORD, based on ESA standards)
User's Manual (WORD, based on ESA standards
Template for Test Plan and Test Report : as HTML page (for complete testing - to be edited with DreamWeaver, as Twiki page (for basic testing)

DFS web pages templates

Any HTML page produced by the DFS Department has to apply the official DFS web page template. This template is consistent with the ESO web project rules. Page source of this HTML template gives instructions about fields to be edited/adapted.

Editing such template must be done either using emacs in HTML mode or vi (on UNIX), or a tool like Dreamweaver (on PC or MacIntosh), to be able to guarantee that "what you see is what you get" with your usual web browser. This means that you must not use other tools like Netscape Composer or StarOffice to generate or modify HTML sources.

A template for HTML page has to be saved locally (using the menu item "File>Save As ..." of your web browser),
If you are editing the HTML source file with EMACS in HTML mode, for instance, all fields to be adapted are surrounded by < !-- #BeginEditable "field-name"--> and < !-- #EndEditable "field-name"--> keywords displayed in red. Please, update/adapt all those fields to have a consistent page.
Rename the file as "(DFSAbb)-(purpose)-(free).html" where (DFSAbb) is one of the standard abbreviation to be used for DFS projects, (purpose) is related to the page goal, and (free) a free string set by you. Example: p2pp-trouble-shooting-dbdown.html can be the name of the trouble shooting page describing what to do in case of P2PP not able to access the DB.
finally, archive the file with the webcheck tool. An automatic email is then sent to the DFS QA manager who will verify the web page location and content.

Here is the template for DFS trouble Shooting pages. Archive it locally. Update it using a recommended tool (see above). Name it as above. And finally archive it via the webcheck command:

filename

An automatic notification will then be sent to khaggouc@eso.org, who will verify the page content and add a link in the DFS users help page.

More templates for DFS

Template for meeting minutes: in Twiki format

Template for Release Notes : Text format

The DMD template for viewgraphs : Power Point format

DFS DepartmentTemplates for documentation