Hi Rajith,
the following link is the *Notation Guide* for confluence that provides
available formats.
http://opensource2.atlassian.com/confluence/oss/renderer/notationhelp.action?section=all
Here are just a few tips for writing documentation that I have found useful.
- read other articles published in confluence to have a feel of the structure and organization of
other articles for consistency.
- keep it simple; don't use too many different fonts and styles.
- create a hierarchical structure first, work on titles and sections first then
focus on the content.
- keep it simple[2], don't use "fancy" words to explain simple things.
- make sure the article has a flow and it is easy to follow.
- keep it simple[3], if the topic being addressed in complex, separate the article in multiple
sections/pages.
- if samples are included, make sure the instructions to get it working are
clear.
Again, these are just a few tips I try to follow myself. Comments are welcome.
HTH
Cheers!
Hernan
Rajith Attapattu wrote:
Hey Hernan,
If u can publish a few tips on basic formatting with confluence that
will help.
Maybe an email or a doc itself within confluence will do.
Regards,
Rajith.
On 1/18/06, *lichtner* <[EMAIL PROTECTED] <mailto:[EMAIL PROTECTED]>>
wrote:
So where is this document now? I am not very familiar with the web site
there seems to be more than one place.
On Wed, 18 Jan 2006, Hernan Cunico wrote:
> Hi Jules,
> many of the articles (if not all) started the same way and many
of them are still a work in progress.
>
> It would be great if you can publish your doc there, I can give
you a hand with the confluence
> formatting if you want to.
>
> Cheers!
> Hernan
>
> Jules Gosnell wrote:
> > Hernan Cunico wrote:
> >
> >> Hi Jules,
> >> can you put your docs in confluence!?
> >>
> >> There is already a section for performance in the TOC, it would be
> >> great if you put the clustering documentation there.
> >
> >
> >
> > OK - can do, if everyone is happy with this...
> >
> > It is a pretty rough doc though... the rest of the stuff in
there looks
> > pretty polished... - this really is a work in progress... - is
that OK ?
> >
> > Jules
> >
> >>
> >> Here is the link to the TOC, to edit confluence you will have to
> >> register first.
> >>
> >>
http://opensource2.atlassian.com/confluence/oss/pages/viewpage.action?pageId=1692
> >>
> >>
> >> Let me know if you need any help with confluence.
> >>
> >> Cheers!
> >> Hernan
> >>
> >> Jules Gosnell wrote:
> >>
> >>> Guys,
> >>>
> >>> I have the beginnings of this doc...
> >>>
> >>> Where would be the best place to keep it ? Ideally it should
be r/w
> >>> by everyone, with history - SVN, WIKI or where ? What is best
practice ?
> >>>
> >>> Also, if in SVN, what format - text, html, ... etc...
> >>>
> >>>
> >>> Jules
> >>>
> >
> >
>
