Date: Thu, 28 Mar 2024 23:15:39 +0100 (CET) Message-ID: <956278864.17535.1711664139052@09e9d69a2016> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_17534_419518334.1711664139051" ------=_Part_17534_419518334.1711664139051 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
The projectdoc Toolbox supports ag= ile teams in writing documentation collaboratively
Lost in wiki space? Blank-Wikipage-Syndrome? Where to add? = How to find? No fun anymore?
Wikis are a great way to add documents relevant for a software developme= nt project.
After a splendid couple of weeks the highly motivated team added plenty = of information to this space.
And step by step
projectdoc tackles these issues by adding structure to
The team can still benefit from the lightweigh= t approach by using a wiki, and combine them with structures the team agree= s upon.
List of features provided by the p= rojectdoc Toolbox
A collection of use cases for the = projectdoc Toolbox
A collection of show cases built w= ith the projectdoc Toolbox
Get an impression on how to work with the = projectdoc Toolbox for Confluence= !
Please check the list of topics that may be rel= evant for your evaluation process!
Compare some native Confluence macros w= ith macros of the projectdoc Toolbox!
If interested, please watch our videos on YouTube (external link to youtube.co= m).
The main concepts of the projectdoc Toolbo= x
Document types define properties and secti= ons a document instance may provide
Agile documenta= tion is about essential and valuable information that teams create just= -in-time.
The projectdoc Toolbox supports agile teams creating and m= aintaining documentation. It provides templates and tools to improve the collaboration of team members.
projectdoc supports all four quadrants of the documentation space. The projectdoc Toolbox provides macros, page and space templates to help you and your team in orga= nizing documentation in multiple Confluence spaces (if needed to).
On agile projects you typically invest in the quadrants 3 and 4. But dep= ending on your team and customer, documents from the two other quadrants ma= y also help you stay productive.
<= /p>
projectdoc is not only for project documentation. It is a tool to organi= ze any information in your wiki.
While it supports modular documentation to enhance team collaboration, t= here are also use cases for individual knowledge workers.
One example is our add-on to create journals or dia= ries.
Employ projectdoc to create workspaces for collecting interesting inform= ation quick-and-dirty or for organizing your information carefully in topic= spaces.
The projectdoc Toolbox for Conflue= nce provides macros an= d templates to help you = structuring your documentation. This keeps you concentrated on the content = valuable for your users and the developing teams by removing distractions s= uch as
The Tour= for Document Authors provides in-depth information on working with the= projectdoc Toolbox.
While the projectdoc Toolbox for C= onfluence provides a basic set of templates to start with, it is easy for development teams to define their own template suite= strong> as a blueprint add-on. Use the free and open-source templa= tes as a basis for your team intern templates!
The Tour= for Template Authors gets you started with defining your own templates= for the projectdoc Toolbox. Learn the basic concepts of the projectdoc Toolbox!
You have questions, need to discuss docume= ntation topics, or would like to suggest new features for projectdoc?
A word of warning...
Every document is a liability. Make sure that every document you write i= s worth its investment. Write sustainable documentation that document the w= hy instead of the how. Do not head for perfection. Strive for automation an= d living documentation! This will make your documentation sustainable, fun = and increase the return of invest.
Here are some quotes concerning documentation and writing that may be yo= ur guide:
Writing is hard work. A clear sentence is no accident. Very few sentence= s come out right the first time, or even the third time. Remember this as a= consolation in moments of despair. If you find that writing is hard, it's = because it is hard. It's one of the hardest things that people do.
William Zinsser. On W= riting Well
Comprehensive documentation does not ensure project success, in fact, it= increases your chance of failure.
Scott Ambler. Best Practices for Agile/L= ean Documentation
Automation also reduces the need for documentation.= span>
Mike Clark. Pragmatic Project Automation: How to Build, Deploy, = and Monitor Java Applications
Design is an inherently messy process, and along the way many descriptio= ns are discarded after serving their purpose.
Rebecca Wirfs-Brock, Alan McKean= . Ob= ject Design: Roles, Responsibilities, and Collaborations. 2003
Outside your extreme programming project, you will probably need documen= tation: by all means, write it. Inside your project, there is so much verba= l communication that you may need very little else. Trust yourselve= s to know the difference.
Ron Jeffries. Essential XP: Documentation
It=E2=80=99s probably fair to say that poor documentation kills more lib= raries and tools than any other issue.
Joe Ottinger. Hand pick the right software project for your situation=
But making written documents that actually help the team produce good so= ftware is a challenge.
Eric Evans. Domain-Driven Design
Paper is better in remembering than your brain.
Gernot Starke
Successful programs not only offer clear documentation but they also rec= ognize that developers don't have a lot of time (or inclination) to sit dow= n and read it.
Daniel Jac= obson, Greg Brail, Dan Woods. APIs: A Strategy Guide. = 2011
Even a whiteboard diagram, or a CRC card, is documentation: the goal isn= 't to avoid documentation, but to document just the right things in just th= e right amount.
James O. Coplien. Lean Architecture: for Agile Software Development
If there is a business need for a document, the customer should request = the document in the same way that she would request a feature: with a story= card. The team will estimate the cost of the document, and the customer ma= y schedule it in any iteration she wishes.
Ron Jeffries. Essential XP: Documentation
The difference between the right word and the almost right word is the d= ifference between lightning and a lightning bug.
Mark Twain. The Wit and Wisdom of Mark Twain
Documenting repeatable processes for anything you will do more than once= is essential to your sanity.
Rob Walling, Mike Taber. Start Small, Stay Small: A Developer's Guide t= o Launching a Startup
Automation will give you back som= ething you don't have enough of: time.
Mike Cla= rk. = Pragmatic Project Automation: How to Build, Deploy, and Monitor Java Applic= ations
The cleaner your design, the less documentation you require.
Sc= ott W. Ambler, Pramod J. Sadalage. Refactoring Databases
Rather than a diagram annotated with text, I write a text document illus= trated with selective and simplified diagrams.
Eric Evans. Domain-Driven Design=
XP is designed to use face to face human communication in place of writt= en documentation wherever possible. Effective conversation is faster and mo= re effective than written documentation. When you bring people together, th= ey need less paperwork.
Ron Jeffries. Essential XP: Documentation
MindTouch, for example, argues that documentation represents potential p= rofit, rather than a cost, because it's not a finely crafted mess of market= ing jargon =E2=80=94 documentation is legitimately useful from a developer'= s perspective. As such, it can help you build and sustain communities!
<= cite>Stephen O'Grady. The New Kingmakers
Intuitiveness does have limitations, however; that=E2=80=99s when develo= pers need documentation. [...] Reading documentation is a last stop rather = than a first stop for many.
Daniel Jacobson, Greg Brail, Dan Woods= . APIs: A Strategy= Guide. 2011