Documentation

NCRRNCRR

Documentation for BioPSE/SCIRun and map3d

Documentation for BioPSE/SCIRun and map3d

All this great software and you want documentation too!?

Documentation

NCRRNCRR

The Central SourceThe Central Source

http://internal.sci.utah.edu/developer/doc/

Documentation

NCRRNCRR

User SupportUser Support

On-line Documentation• Tutorial• User’s Manual• FAQ Lists

Printed Documentation• User’s Manuals

Mailing List 182 registered) Direct Contact• Email and Bugzilla• Phone

Documentation

NCRRNCRR

TutorialTutorial

Documentation

NCRRNCRR

Documentation Development

Documentation Development

So How Does this Documentation Thing Happen?

Documentation

NCRRNCRR

The Central SourceThe Central Source

http://internal.sci.utah.edu/developer/doc/

Documentation

NCRRNCRR

Developer SupportDeveloper Support

Documentation• Programmer’s Guide• Module descriptions• Online code views• FAQ

Mailing ListDirect Contact• Email and Bugzilla• Network meetings (Access Grid)

Documentation

NCRRNCRR

Installation SupportInstallation Support

Documentation• Quick Start• Installation Guide• Third party packages• FAQ

Mailing ListDirect Contact• Email and Bugzilla

Documentation

NCRRNCRR

Internal ManagementInternal Management

Masterplan•Procedures and content•Module writing guide•Dynamic document

Technical Production•LaTeX, HTML, XML•Support for content providers•Online and paper forms

Documentation

NCRRNCRR

MasterplanMasterplan

•Roadmap•Status report•Dynamic links

Documentation

NCRRNCRR

Technical ProductionTechnical Production

XML

HTML

PDF

LaTeX

Existing Tools• LaTeX, latex2html,

DocBook (XML)

New Tools• XML DTDs,

automation

Content Generation• Voice

recording/recognition• Technical writer

Documentation

NCRRNCRR

External SupportExternal Support

NCRR documentation website•Updated daily

Downloaded documentation• Linked to installed release•Web based and printable docs

Submitting new documentation•Required for module submission

Documentation

NCRRNCRR

Submitting New DocsSubmitting New Docs

Format• XML- required for each module- can include complete description- template available, validation soon

• LaTeX- can include complete description- template available

Documentation

NCRRNCRR

Making DocsMaking Docs

Merged at doc generation time• XML and LaTeX are sources (not HTML!)• printed documentation• web documentation

Tools (soon available)• validation of XML and LaTeX• Convert XML to HTML and TeX• Convert LaTeX to HTML• LaTeX/TeX to printed documents