Author: mseidel
Date: Tue Feb 5 12:53:00 2019
New Revision: 1853002
URL: http://svn.apache.org/viewvc?rev=1853002&view=rev
Log:
Re-upload because of list formatting
Modified:
openoffice/site/trunk/content/orientation/intro-doc.mdtext
Modified: openoffice/site/trunk/content/orientation/intro-doc.mdtext
URL:
http://svn.apache.org/viewvc/openoffice/site/trunk/content/orientation/intro-doc.mdtext?rev=1853002&r1=1853001&r2=1853002&view=diff
==============================================================================
--- openoffice/site/trunk/content/orientation/intro-doc.mdtext (original)
+++ openoffice/site/trunk/content/orientation/intro-doc.mdtext Tue Feb 5
12:53:00 2019
@@ -36,11 +36,11 @@ As a popular end-user facing product, Ap
When users have a question, when they get stuck, there are a wide range of
options for them:
- - They might ask a friend for help
- - They might search Google for help
- - They might press F1 in the application and look for help
- - They might post a question to our [community support
forum](https://forum.openoffice.org/)
- - They might go to the [OpenOffice.org
website](https://www.openoffice.org) and look for a solution there
+ - They might ask a friend for help
+ - They might search Google for help
+ - They might press F1 in the application and look for help
+ - They might post a question to our [community support
forum](https://forum.openoffice.org/)
+ - They might go to the [OpenOffice.org website](https://www.openoffice.org)
and look for a solution there
The documentation we write aids both the end-users as well as those who
support the end users. We aim to provide authoritative, up-to-date material for
Apache OpenOffice, and to aid users of all skill levels. If we do our tasks
well, users are more satisfied and more productive.
@@ -48,9 +48,9 @@ The documentation we write aids both the
We maintain documentation in a variety of forms:
- - Built-in help files that are included in the product installs. These
are context-sensitive help files that you get when you press "F1" in an
OpenOffice application.
- - User Guides that are available on the website. These include a
mixture of overview and task-specific topics.
- - Special topics, such as migration guides, scripting cookbooks, etc.
+ - Built-in help files that are included in the product installs. These are
context-sensitive help files that you get when you press "F1" in an OpenOffice
application.
+ - User Guides that are available on the website. These include a mixture of
overview and task-specific topics.
+ - Special topics, such as migration guides, scripting cookbooks, etc.
All OpenOffice documentation is housed on the [OpenOffice
wiki](https://wiki.openoffice.org/wiki/Documentation) for ease of maintenance
by volunteers with the exception of the help files which are integrated with
the OpenOffice product itself.
@@ -58,10 +58,10 @@ All OpenOffice documentation is housed o
In our documentation work we need to be aware of the following goals and
constraints:
- - Only around 1/3 of OpenOffice users speak English as their native
language. This is true also of the volunteers working on documentation. So in
our list conversations, and in our documentation, we should aim for good,
simple English prose, avoiding regional idioms and jargon. By convention we're
adopting U.S. English spelling for the documentation. So we should plan for the
documentation we write to be translated at some point.
- - We should also write the documentation so it can be translated into
other languages. This means we need to be careful about how we mix text and
graphics together in any diagrams.
- - We use the [Apache License
2.0](https://www.apache.org/licenses/LICENSE-2.0.html) for all project
deliverables. This "permissive" open source license ensures that everyone has
the ability to adapt and reuse the documentation that we create. But it also
means that we need to be careful about what other 3rd party material we use in
our documentation. Until you are familiar with the Apache rules for using 3rd
party material into an Apache product, you should start a discussion on the
mailing list for any 3rd party material you want to reuse. This includes
material from the legacy OpenOffice.org project as well, since some of that was
under a different license.
- - We're aiming to provide as much content as possible in the form of
MWiki pages. These are easy for users to access, from any device. Also, since
they are indexed by search engines they will be easy to find for the users who
like to resolve issues by searching Google for solutions.
+ - Only around 1/3 of OpenOffice users speak English as their native
language. This is true also of the volunteers working on documentation. So in
our list conversations, and in our documentation, we should aim for good,
simple English prose, avoiding regional idioms and jargon. By convention we're
adopting U.S. English spelling for the documentation. So we should plan for the
documentation we write to be translated at some point.
+ - We should also write the documentation so it can be translated into other
languages. This means we need to be careful about how we mix text and graphics
together in any diagrams.
+ - We use the [Apache License
2.0](https://www.apache.org/licenses/LICENSE-2.0.html) for all project
deliverables. This "permissive" open source license ensures that everyone has
the ability to adapt and reuse the documentation that we create. But it also
means that we need to be careful about what other 3rd party material we use in
our documentation. Until you are familiar with the Apache rules for using 3rd
party material into an Apache product, you should start a discussion on the
mailing list for any 3rd party material you want to reuse. This includes
material from the legacy OpenOffice.org project as well, since some of that was
under a different license.
+ - We're aiming to provide as much content as possible in the form of MWiki
pages. These are easy for users to access, from any device. Also, since they
are indexed by search engines they will be easy to find for the users who like
to resolve issues by searching Google for solutions.
##Volunteers are Welcome
@@ -71,11 +71,11 @@ For some specialized areas skills in gra
Volunteers on the Documentation Team work on a variety of tasks, including:
- - Authoring draft documentation on a specific area of the OpenOffice
product.
- - Reviewing draft documentation for technical correctness, e.g.,
repeating the steps described in a task and verifying that they are complete
and no steps are missing.
- - Editing draft documentation for clarity and style.
- - Preparing screenshots, diagrams and artwork for covers.
- - Developing tools and scripts to aid in repetitive tasks, such as
document format conversions.
+ - Authoring draft documentation on a specific area of the OpenOffice product.
+ - Reviewing draft documentation for technical correctness, e.g., repeating
the steps described in a task and verifying that they are complete and no steps
are missing.
+ - Editing draft documentation for clarity and style.
+ - Preparing screenshots, diagrams and artwork for covers.
+ - Developing tools and scripts to aid in repetitive tasks, such as document
format conversions.
##Getting Started
