DOCSLIB.ORG

Confluence, Tech Comm, Chocolate

Total Page：16

File Type：pdf, Size：1020Kb

Download full-text PDF Read full-text
Confluence, Tech Comm, Chocolate # & $ % & Confluence, Tech Comm, Chocolate, A wiki as platform extraordinaire for technical communication Sarah Maddox PRESS Confluence, Tech Comm, Chocolate, Copyright © 2012 Sarah Maddox All rights reserved. No part of this book may be reproduced or transmitted in any form or by any means without the prior written permission of the copyright holder, except for the inclusion of brief quotations in a review. Graphics credits Illustrations: Ryan Maddox The cover design, book design, and the XML Press logo are copyright © 2012 XML Press. The cover illustra- tion and interior illustrations are copyright © 2012 Ryan Maddox. Disclaimer The information in this book is provided on an “as is” basis, without warranty. While every effort has been taken by the author and XML Press in the preparation of this book, the author and XML Press shall have neither liability nor responsibility to any person or entity with respect to any loss or damages arising from the information contained in this book. This book contains links to third-party web sites that are not under the control of the author or XML Press. The author and XML Press are not responsible for the content of any linked site. Inclusion of a link in this book does not imply that the author or XML Press endorses or accepts any responsibility for the content of that third-party site. Trademarks XML Press and the XML Press logo are trademarks of XML Press. All terms mentioned in this book that are known to be trademarks or service marks have been capitalized as appropriate. Use of a term in this book should not be regarded as affecting the validity of any trademark or service mark. XML Press Laguna Hills, California http://xmlpress.net First Edition ISBN: 978-1-937434-00-7 Table of Contents I. Introduction ........................................................................................................ 1 1. Welcome to this book ......................................................................................... 3 Getting passionate about technical communication and wikis .......................................... 4 How to use this book ....................................................................................... 7 How we produced this book .............................................................................. 10 Disclaimer .................................................................................................. 11 Acknowledgments ........................................................................................ 11 Confluence quick start .................................................................................... 13 Have fun in this book! ..................................................................................... 13 References ................................................................................................. 13 2. Introducing the wiki ......................................................................................... 15 Let’s talk about wikis ...................................................................................... 15 What is a wiki? ............................................................................................. 16 What do people mean when they say “wiki?” ............................................................ 17 The major wiki brands ..................................................................................... 18 A wiki by any other name… .............................................................................. 19 Some well known wiki sites ............................................................................... 20 Technical documentation wiki sites ...................................................................... 22 Do they all look the same? ................................................................................ 25 Plugins, add-ons and extensions ......................................................................... 25 Wiki and tech comm ...................................................................................... 26 What you now know about wikis ......................................................................... 29 References ................................................................................................. 29 3. Getting to know Confluence wiki .......................................................................... 31 Let’s talk about Confluence and its makers .............................................................. 32 Introducing Confluence and Atlassian ................................................................... 32 What is in the wiki? ........................................................................................ 34 Wiki as subversive technology ............................................................................ 42 Why do they call Confluence an enterprise wiki? ........................................................ 43 Confluence 4 ............................................................................................... 45 Confluence is now your friend ............................................................................ 47 References ................................................................................................. 47 II. Developing documentation on a wiki ................................................................... 49 4. Planning your wiki documentation ........................................................................ 51 Let’s talk about planning your wiki ....................................................................... 51 Analyzing your documentation requirements ........................................................... 52 Choosing a wiki ............................................................................................ 54 Understanding the server and machine .................................................................. 57 Planning your user management and global permissions .............................................. 58 Dividing your content into spaces ........................................................................ 59 iv Table of Contents Deciding if you need to add plugins ..................................................................... 60 Getting to know your wiki ................................................................................ 61 Wikitoria ................................................................................................... 61 What you know about planning your wiki ............................................................... 63 References ................................................................................................. 63 5. Getting started on the wiki .................................................................................. 65 Let’s get a documentation wiki up and running ......................................................... 65 Installing your own Confluence or signing up for Confluence OnDemand ............................ 66 Adding users and groups ................................................................................. 73 Adding a documentation space .......................................................................... 74 Setting permissions ....................................................................................... 76 Adding the space description ............................................................................ 81 Designing the space home page ......................................................................... 81 Adding pages and creating the table of contents ....................................................... 84 Kay’s chocolate cake: part 1 ............................................................................... 87 What you have done so far ............................................................................... 88 References ................................................................................................. 88 6. Developing content ......................................................................................... 91 Getting acquainted with the Confluence editor ......................................................... 92 The editor in Confluence 3.5 .............................................................................. 92 The editor in Confluence 4 ................................................................................ 95 Wiki markup explained .................................................................................... 96 Editor quick reference guide ............................................................................ 102 Editing a page ............................................................................................ 104 Adding screenshots and other images to your page ................................................... 107 Drawing diagrams ....................................................................................... 108 What you have learned about developing content .................................................... 112 References ................................................................................................ 113 7. Structure and style ......................................................................................... 115 In search of structure, style and branding .............................................................. 115 Adding structure to a page .............................................................................
Load more

Recommended publications
  • Wikis with Moinmoin Wiki Creative Group Writing
    KNOW HOW MoinMoin Wiki Building wikis with MoinMoin Wiki Creative Group Writing The members of a project team can profit from collecting their ideas, or any loose ends, in a central repository. Wikis are tailor-made for this task. BY HEIKE JURZIK ay before content manage- ment systems started to Wappear for website manage- ment, Wikis provided a kind of “open door” to HTML pages, allowing any visi- tor to click and edit the HTML content. Wiki is the abbreviation for WikiWiki- Web – “wiki wiki” is derived from Hawaiian and means “quick” or “quickly”. And the open authoring sys- restored at any time, should a page be MySQL, Oracle, or PostgreSQL. The soft- tem certainly is quick. The MoinMoin deleted or damaged by mistake. Also, ware then uses this data to create the Wiki engine is one of the better-known wikis allow you to assign special access public HTML pages. implementations of this technology. controls that can restrict editing to regis- Besides taking a look at the original Users can click to launch the embed- tered users, if required. wiki, you might like to visit what is cur- ded editor and access the content and The first wiki website was published rently the biggest wiki on the Web, the structure of the page they want to mod- by Ward Cunningham in 1995, and it is Wikipedia [3], which offers innumerable ify. Typically, an Edit link is provided to still online [1]. At the time, Cunningham articles on pages in multiple languages. make things easier. wrote an email message saying that he It is an example of how well information In contrast to “real” HTML, which had programmed a new kind of database can be organized with a wiki.
    [Show full text]
  • Research Article Constrained Wiki: the Wikiway to Validating Content
    Hindawi Publishing Corporation Advances in Human-Computer Interaction Volume 2012, Article ID 893575, 19 pages doi:10.1155/2012/893575 Research Article Constrained Wiki: The WikiWay to Validating Content Angelo Di Iorio,1 Francesco Draicchio,1 Fabio Vitali,1 and Stefano Zacchiroli2 1 Department of Computer Science, University of Bologna, Mura Anteo Zamboni 7, 40127 Bologna, Italy 2 Universit´e Paris Diderot, Sorbonne Paris Cit´e, PPS, UMR 7126, CNRS, F-75205 Paris, France Correspondence should be addressed to Angelo Di Iorio, [email protected] Received 9 June 2011; Revised 20 December 2011; Accepted 3 January 2012 Academic Editor: Kerstin S. Eklundh Copyright © 2012 Angelo Di Iorio et al. This is an open access article distributed under the Creative Commons Attribution License, which permits unrestricted use, distribution, and reproduction in any medium, provided the original work is properly cited. The “WikiWay” is the open editing philosophy of wikis meant to foster open collaboration and continuous improvement of their content. Just like other online communities, wikis often introduce and enforce conventions, constraints, and rules for their content, but do so in a considerably softer way, expecting authors to deliver content that satisfies the conventions and the constraints, or, failing that, having volunteers of the community, the WikiGnomes, fix others’ content accordingly. Constrained wikis is our generic framework for wikis to implement validators of community-specific constraints and conventions that preserve the WikiWay and their open collaboration features. To this end, specific requirements need to be observed by validators and a specific software architecture can be used for their implementation, that is, as independent functions (implemented as internal modules or external services) used in a nonintrusive way.
    [Show full text]
  • Caution and Guidance for the Social Media Savvy Physician Wajid I
    COMMENTARY Caution and guidance for the social media savvy physician Wajid I. Khan1 Citation: UBCMJ. 2020: 11.2 (32-33) Abstract The advent of social media has brought forth the freedom to communicate information instantly to a large audience and its application in medicine has been beneficial for both patients and practitioners. Healthcare institutions and practitioners are utilizing the power of social media to inform and educate their peers and patients as well as the public. Patients are engaging in social discourse online, enabling them to become more involved in and informed about healthcare. It is in this climate that the matters of professionalism and patient privacy become a concern. Without a formal system of peer-review and the perception of anonymity, posting content on social media websites by healthcare providers is susceptible to crossing professional and ethical boundaries. Medical students and residents should be especially careful when posting online, as unprofessional content is common in their groups. Physicians should also be wary of self-promotion through entertainment, or “medutainment,” which can put patient privacy in harm’s way. When doctors review their intentions and follow guidelines (such as the Canadian Medical Protection Association tips) prior to posting on social media, a beneficial outcome can be achieved. ver the last decade, the accessibility and popularity of social Patient confidentiality is another concern when doctors use Omedia have empowered both patients and physicians to share social media. The tendency for online content to stray into medical their opinions and stories online. Patients are using Twitter to express education entertainment, or “medutainment,” can place privacy their dissatisfaction with healthcare,1 and joining Facebook groups at risk.
    [Show full text]
  • Dokuwiki Download Windows
    Dokuwiki download windows DokuWiki on a Stick can be downloaded from the official DokuWiki download page. Just choose the option under “Include Web-Server”. Download DokuWiki! Here you can download the latest DokuWiki-Version. Either just MicroApache (Windows) Apache , PHP , GD2 and SQLite ​Install:upgrade · ​Upgrade · ​Hosting · ​DokuWiki Archived Downloads. To create an “on the Stick” edition of DokuWiki, visit and check the “MicroApache (Windows)” checkbox in the. DokuWiki is a great wiki engine with minimal requirements that usually gets Download the non- thread-safe version of PHP for Windows from. XAMPP is a popular WAMP stack for the Windows operating system. Download the DokuWiki zip file from (e.g. Bitnami native installers automate the setup of a Bitnami application stack on Windows, OS X or Linux. Each installer includes all of the software necessary to run. The Bitnami DokuWiki Stack provides a one-click install solution for DokuWiki. Download installers and virtual machines, or run your own DokuWiki server in the. Download the executable file for the Bitnami DokuWiki Stack from the Bitnami This tool is named on Windows and is located in the. How to install DokuWiki on Windows XP in less then 5 minutes: 1) Download and install WAMP5 (or the latest version) for Windows XP. How install DokuWiki on your server . Install DokuWiki on windows 7 localhost (XAMPP + php7. DokuWiki latest version: Free and User-Friendly Open-Source Information Storage Software. DokuWiki is Download DokuWiki for Windows. DokuWiki ist eine schlanke Wiki-Anwendung auf PHP-Basis, die ohne Datenbank auskommt und eingetragene Texte als TXT-Dateien ablegt.
    [Show full text]
  • WHY USE a WIKI? an Introduction to the Latest Online Publishing Format
    WHY USE A WIKI? An Introduction to the Latest Online Publishing Format A WebWorks.com White Paper Author: Alan J. Porter VP-Operations WebWorks.com a brand of Quadralay Corporation [email protected] WW_WP0309_WIKIpub © 2009 – Quadralay Corporation. All rights reserved. NOTE: Please feel free to redistribute this white paper to anyone you feel may benefit. If you would like an electronic copy for distribution, just send an e-mail to [email protected] CONTENTS Overview................................................................................................................................ 2 What is a Wiki? ...................................................................................................................... 2 Open Editing = Collaborative Authoring .................................................................................. 3 Wikis in More Detail................................................................................................................ 3 Wikis Are Everywhere ............................................................................................................ 4 Why Use a Wiki...................................................................................................................... 5 Getting People to Use Wikis ................................................................................................... 8 Populating the Wiki................................................................................................................. 9 WebWorks ePublisher and Wikis
    [Show full text]
  • Which Wiki for Which Uses
    Which wiki for which uses There are over 120 Wiki software available to set up a wiki plateform. Those listed below are the 13 more popular (by alphabetic order) wiki engines as listed on http://wikimatrix.org on the 16th of March 2012. The software license decides on what conditions a certain software may be used. Among other things, the software license decide conditions to run, study the code, modify the code and redistribute copies or modified copies of the software. Wiki software are available either hosted on a wiki farm or downloadable to be installed locally. Wiki software Reference Languages Wikifarm Technology Licence Main audience Additional notes name organization available available very frequently met in corporate environment. Arguably the most widely deployed wiki software in the entreprise market. A zero- Confluence Atlassian Java proprietary 11 confluence entreprise cost license program is available for non-profit organizations and open source projects aimed at small companies’ documentation needs. It works on plain DokuWiki several companies Php GPL2 50 small companies text files and thus needs no database. DrupalWiki Kontextwork.de Php GPL2+ 12 entreprise DrupalWiki is intended for enterprise use Entreprise wiki. Foswiki is a wiki + structured data + Foswiki community Perl GPL2 22 entreprise programmable pages education, public Wikimedia Php with backend MediaWiki is probably the best known wiki software as it is the MediaWiki GPLv2+ >300 wikia and many hostingservice, companies private Foundation and others database one used by Wikipedia. May support very large communities knowledge-based site MindTouchTCS MindTouch Inc. Php proprietary 26 SamePage partly opensource and partly proprietary extensions Jürgen Hermann & Python with flat tech savy MoinMoin GPL2 10+ ourproject.org Rather intended for small to middle size workgroup.
    [Show full text]
  • Using Wikis in Software Development
    open source Editor: Christof Ebert ■ Alcatel ■ [email protected] Using Wikis in Software Development Panagiotis Louridas In only a few years, wikis have become one of the most popular tool shells imaginable based on open source software. You can find them just about everywhere that demands effective col- laboration and knowledge sharing at a low budget. Wikipedia has certainly enhanced their pop- ularity, but they also have a place in intranet-based applications such as defect tracking, re- quirements management, test-case management, and project portals. Panagiotis Louridas describes wiki essentials and nicely distinguishes a variety of types. You’ll find something useful, I’m sure. —Christof Ebert y 1995, Ward Cunningham, a promi- What is a wiki? nent member of the design patterns A wiki is actually two things: community, was experimenting with a hypertext environment to promote the ■ a program that makes it exceptionally easy exchange of the community’s ideas. for anybody to edit Web pages and B ■ The environment was based on the a philosophy regarding how users should then-popular Apple Hyper- go about that editing. Card application. That applica- tion worked well for individual Generally, Web pages are written in HTML. users, but Cunningham was While it’s not difficult to learn HTML, non- looking for a Web-based imple- programmers tend to shy away from it. Even mentation. On 25 March 1995, programmers find it easier to edit text than he posted the Web’s first-ever structured HTML, where linking between wiki, calling it “the simplest pages requires attention to things such as ad- online database that could pos- dresses and anchors.
    [Show full text]
  • Moinmoin Documentation Release 0.1.Dev196+G250faa1
    MoinMoin Documentation Release 0.1.dev196+g250faa1 The MoinMoin developers Aug 22, 2021 Contents 1 General 3 1.1 About MoinMoin.............................................3 1.2 What makes MoinMoin special?.....................................4 1.3 Who is using MoinMoin?........................................4 2 Features 7 2.1 Operating System Support........................................7 2.2 Servers..................................................7 2.3 Authentication..............................................8 2.4 Authorization...............................................8 2.5 Anti-Spam................................................8 2.6 Storage..................................................8 2.7 Search / Indexing.............................................9 2.8 User Interface..............................................9 2.9 Logging.................................................. 10 2.10 Technologies............................................... 11 3 License 13 4 Using MoinMoin 21 4.1 User Accounts.............................................. 21 4.2 Markups Supported by MoinMoin.................................... 24 4.3 Templates and Meta Data........................................ 77 4.4 Searching and Finding.......................................... 78 4.5 File Upload................................................ 81 4.6 Namespaces............................................... 82 4.7 User Subscriptions............................................ 82 5 Administrating MoinMoin 85 5.1 Requirements..............................................
    [Show full text]
  • IBM Research Report On-Line Collaborative Software
    RC24249 (C0704-012) April 30, 2007 Computer Science IBM Research Report On-line Collaborative Software Development via Wiki WenPeng Xiao, ChangYan Chi, Min Yang IBM Research Division China Research Laboratory Building 19, Zhouguancun Software Park 8 Dongbeiwang West Road, Haidian District Beijing, 100094 P.R.C. Research Division Almaden - Austin - Beijing - Haifa - India - T. J. Watson - Tokyo - Zurich LIMITED DISTRIBUTION NOTICE: This report has been submitted for publication outside of IBM and will probably be copyrighted if accepted for publication. It has been issued as a Research Report for early dissemination of its contents. In view of the transfer of copyright to the outside publisher, its distribution outside of IBM prior to publication should be limited to peer communications and specific requests. After outside publication, requests should be filled only by reprints or legally obtained copies of the article (e.g. , payment of royalties). Copies may be requested from IBM T. J. Watson Research Center , P. O. Box 218, Yorktown Heights, NY 10598 USA (email: [email protected]). Some reports are available on the internet at http://domino.watson.ibm.com/library/CyberDig.nsf/home . On-line Collaborative Software Development via Wiki WenPeng Xiao ChangYan Chi Min Yang IBM China Research Lab IBM China Research Lab IBM China Research Lab 86-10-58748423 86-10-58748012 86-10-58748544 [email protected] [email protected] [email protected] ABSTRACT documentation or even idea to a project when s/he is attracted. Wiki is a collaborative authoring system for collective intelligence However, nearly all currently available development tools are which is quickly gaining popularity in content publication.
    [Show full text]
  • Awesome Selfhosted - Wikis
    Awesome Selfhosted - Wikis Wikis Related: Software Development - Documentation Generators See also: Wikimatrix, Wiki Engines - WikiIndex, List of wiki software - Wikipedia, Comparison of wiki software - Wikipedia. BookStack - BookStack is a simple, self-hosted, easy-to-use platform for organizing and storing information. It allows for documentation to be stored in a book like fashion. (Demo, Source Code) MIT PHP Cowyo - Cowyo is a feature-rich wiki for minimalists. (Demo) MIT Go django-wiki - Wiki system with complex functionality for simple integration and a superb interface. Store your knowledge with style: Use django models. (Demo) GPL-3.0 Python Documize - Modern Docs + Wiki software with built-in workflow, single binary executable, just bring MySQL/Percona. (Source Code) AGPL-3.0 Go Dokuwiki - Easy to use, lightweight, standards-compliant wiki engine with a simple syntax allowing reading the data outside the wiki. All data is stored in plain files, therefore no database is required. (Source Code) GPL-2.0 PHP Gitit - Wiki program that stores pages and uploaded files in a git repository, which can then be modified using the VCS command line tools or the wiki's web interface. GPL-2.0 Haskell Gollum - Simple, Git-powered wiki with a sweet API and local frontend. MIT Ruby jingo - Git based wiki engine written for node.js, with a decent design, a search capability and good typography. MIT Nodejs Mediawiki - MediaWiki is a free and open-source wiki software package written in PHP. It serves as the platform for Wikipedia and the other Wikimedia projects, used by hundreds of millions of people each month.
    [Show full text]
  • Wiki and Blogs
    Wiki and Blogs Ashish Mahabal Ay/Bi 199b 29 Mar 2011 Which Wiki? • Many to choose from • pmwiki –Patrick R Michaud –http://www.pmwiki.org/ Wiki markup Raw Transformed PQ wiki pmwiki latest stable 2.2.25 local/config.php $DefaultPasswords['admin'] = crypt('SomeAdminPassHere'); $DefaultPasswords['edit'] = crypt('SomeEditPassHere'); http://www.astro.caltech.edu/quest/pmwiki/pmwiki.php A few wiki engines • MediaWiki (http://www.mediawiki.org) • PmWiki (http://www.pmwiki.org) • MoinMoin (http://moinmo.in) • Twiki (http://twiki.org) Creole: (http://www.wikicreole.org) The lightweight markup language for formatting wikitext. It is aimed at being a common markup language for wikis to enable simple transfer of content between different wiki engines. (See also http://wiki.wikicreole.org) Blogs • Blogspot (http://www.blogger.com) • Wordpress (http://wordpress.org) • TypePad (http://www.typepad.com/) • Movable Type (http://MovableType.com) • … Vlogs, audio blogs, diary, groups, blogsphere, … RSS feeds, subscribing, … Using Yahoo Pipes Using APIs " (Application Programming Interface) • Each blogspot blog has an associated number. My movies blog, for instance, has the number 31487588. It can be seen when you post a new item in your blog. You can obtain the xml for your blog using that number and some utility like wget or curl: • wget http://www.blogger.com/feeds/31487588/ posts/default This gives you a few of the last entries To get a large number of, or all, entries, use something like: wget http://www.blogger.com/feeds/31487588/posts/default?max- results=20000 For getting entries between two dates, use the following format: wget http://www.blogger.com/feeds/31487588/posts/default?published- min=2008-03-16T00:00:00&published-max=2009-03-24T23:59:59 To get those with specific labels e.g.
    [Show full text]
  • Feasibility Study of a Wiki Collaboration Platform for Systematic Reviews
    Methods Research Report Feasibility Study of a Wiki Collaboration Platform for Systematic Reviews Methods Research Report Feasibility Study of a Wiki Collaboration Platform for Systematic Reviews Prepared for: Agency for Healthcare Research and Quality U.S. Department of Health and Human Services 540 Gaither Road Rockville, MD 20850 www.ahrq.gov Contract No. 290-02-0019 Prepared by: ECRI Institute Evidence-based Practice Center Plymouth Meeting, PA Investigator: Eileen G. Erinoff, M.S.L.I.S. AHRQ Publication No. 11-EHC040-EF September 2011 This report is based on research conducted by the ECRI Institute Evidence-based Practice Center in 2008 under contract to the Agency for Healthcare Research and Quality (AHRQ), Rockville, MD (Contract No. 290-02-0019 -I). The findings and conclusions in this document are those of the author(s), who are responsible for its content, and do not necessarily represent the views of AHRQ. No statement in this report should be construed as an official position of AHRQ or of the U.S. Department of Health and Human Services. The information in this report is intended to help clinicians, employers, policymakers, and others make informed decisions about the provision of health care services. This report is intended as a reference and not as a substitute for clinical judgment. This report may be used, in whole or in part, as the basis for the development of clinical practice guidelines and other quality enhancement tools, or as a basis for reimbursement and coverage policies. AHRQ or U.S. Department of Health and Human Services endorsement of such derivative products or actions may not be stated or implied.
    [Show full text]