[TYPO3-doc] Official documentation categories defined
Francois Suter
fsu-lists at cobweb.ch
Sat Apr 17 22:33:58 CEST 2010
Hi all,
As just announced, here's a first draft of definitions for the big three
official documentation categories. This is the text that would appear
somewhere close the beginning of every official manual.
---
Core Manual
This document is a Core Manual. This means that it is related to the
internal working of TYPO3 and aims to provide the reader with in-depth
information about the topic it covers, in particular how it is
implemented into the TYPO3 source code, what APIs are available,
configuration options that might exist, etc.
Core Manuals are not meant to be read in one go. The reader should rely
on the table of content to identify what particular section should be of
help depending on the task at hand.
---
Guide
This document is a Guide. This means that it was designed to cover the
whole breadth of a particular topic. It is hoped that the reader will
feel confident and well-informed in the particular topic after having
read a Guide from cover to cover. The Guides are practical manuals that
a reader will probably want to refer to again and again when checking
some topic. It is meant to offer advice on how best to achieve some
given tasks.
---
Tutorials
This document is a Tutorial. This means that it is a step-by-step manual
designed to walk a beginner through some topic. The Tutorials provide
many examples to help learn and understand the subject they cover. They
also offer advice on potential pitfalls or highlight the most important
things to remember. Lastly each Tutorial points the reader in the right
direction for the next steps to take.
---
Furthermore I would like to add a paragraph that clearly identifies a
manual as an official one, in particular for newcomers who will not be
familiar with our conventions. Here's what I propose:
"Official documentation
This document is part of the official TYPO3 documentation. This means
that is has been approved by the TYPO3 Documentation Team after going
through a peer-review process. The reader can expect the information in
such documents to be exact (except for uncaught mistakes, of course).
Official documents are kept up to date to the best of the Documentation
Team's abilities."
Thanks in advance for your feedback
--
Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch
More information about the TYPO3-project-documentation
mailing list