Documenting with DITA in Drupal
If you can't read please download the document
-
Upload
kristof-van-tomme -
Category
Technology
-
view
2.627 -
download
2
Transcript of Documenting with DITA in Drupal
LEVERAGING COMMUNITIESDocumenting products with DITA in DRUPAL
Kristof Van [email protected]
COPY
COLLECTION
PROCESSING
AND
ENHANCINGASSEMBLY &
FEEDBACKDevelopers ManagersProduct owners
Documentation
professionals
SalesSupportManagersEnd-users
LEVERAGING COMMUNITIESInformationPULLInformationPUSH
COPY
COLLECTION
PROCESSING
AND
ENHANCINGASSEMBLY &
FEEDBACKDevelopers ManagersProduct owners
Documentation
professionals
SalesSupportManagersEnd-users
User storiesTechnicalspecificationFunctionalspecificationCommunityFeedback
LEVERAGING COMMUNITIES
COPY
COLLECTION
PROCESSING
AND
ENHANCINGASSEMBLY &
FEEDBACKDevelopers ManagersProduct owners
Documentation
professionals
SalesSupportManagersEnd-users
User storiesTechnicalspecificationFunctionalspecificationSimplifiedTOPICS
CommunityFeedbackSelf serviceDocumentationAssemblyEdited
TOPICSEditingUsabilityimprovements
DITA MAPS& EXPORTS
LEVERAGING COMMUNITIES
COPY
COLLECTION
PROCESSING
AND
ENHANCINGASSEMBLY &
FEEDBACKDevelopers ManagersProduct owners
Documentation
professionals
SalesSupportManagersEnd-users
User storiesTechnicalspecificationFunctionalspecificationSimplifiedTOPICS
CommunityFeedbackSelf serviceDocumentationAssemblyEdited
TOPICSEditingUsabilityimprovements
DITA MAPS& EXPORTS
LEVERAGING COMMUNITIES
MODULAR3-STEPPROCESS
LEVERAGING COMMUNITIESModular 3-step process
Copy collectionand Pre-formatting
Drupal site
SimplifiedTOPICSEdited
TOPICS& exampleMAPSExistingDocumentationProcess
Editor of choiceAssembly of documentationdocuments andFeedback
Drupal site
PROCESSING
AND
ENHANCINGASSEMBLY &
FEEDBACKDevelopers ManagersProduct owners
Documentation
professionals
SalesSupportManagersEnd-users
User storiesTechnicalspecificationFunctionalspecificationSimplifiedTOPICS
CommunityFeedbackSelf serviceDocumentationAssemblyEdited
TOPICSEditingUsabilityimprovements
DITA MAPS& EXPORTS
LEVERAGING COMMUNITIES
COPY
COLLECTION
UPSTREAM
LEVERAGING COMMUNITIESCollecting and reusing artifacts from the production process
Different types of materialsUser stories
Functional specifications
Technical specifications
Issue tracker logs
Aggregate, index, search, map and re-use
LEVERAGING COMMUNITIESDrupal modules you could use
Aggregate/ImportFeeds (RSS, CSV, HTML, TXT, OPML, XML)
Table Wizard and Migrate (SQL, CSV)
CMIS API (Sharepoint, Alfresco)
SearchApache Solr, Faceted search
TagTaxonomy
LEVERAGING COMMUNITIESNew modules for the Upstream process
Poorman's DITAUse a Drupal form to create basic DITA topics
Currently implemented for tasks and concepts
Search and insertSearch aggregated content and insert it in the forms
PROCESSING
AND
ENHANCINGASSEMBLY &
FEEDBACKDevelopers ManagersProduct owners
Documentation
professionals
SalesSupportManagersEnd-users
User storiesTechnicalspecificationFunctionalspecificationSimplifiedTOPICS
CommunityFeedbackSelf serviceDocumentationAssemblyEdited
TOPICSEditingUsabilityimprovements
DITA MAPS& EXPORTS
LEVERAGING COMMUNITIES
COPY
COLLECTION
EditingUsabilityimprovements
DOC-TEAM
LEVERAGING COMMUNITIESPre-formatted starting material for the professionals
Modular process: no need to switch DITA editor software
No extra licenses needed to involve all stakeholders (upstream and downstream)
Better integration of different information silos
Less field knowledge required from the documentation professionals
Better and more feedback from end-users
COPY
COLLECTION
PROCESSING
AND
ENHANCINGASSEMBLY &
FEEDBACKDevelopers ManagersProduct owners
Documentation
professionals
SalesSupportManagersEnd-users
User storiesTechnicalspecificationFunctionalspecificationSimplifiedTOPICS
CommunityFeedbackSelf serviceDocumentationAssemblyEdited
TOPICSEditingUsabilityimprovements
DITA MAPS& EXPORTS
LEVERAGING COMMUNITIES
DOWNSTREAM
LEVERAGING COMMUNITIESModular: import DITA documentation
Upload individual files
Import foldersAutomatic checkout from a version controlled documentation repository
Drupal checks for updates
Other import options can be tailored for specific use cases to plugin to existing processes
LEVERAGING COMMUNITIESCommunity feedback and subscriptions
Feedback mechanismsTagging (taxonomy)
Flagging/bookmarking (flag)
Rating (voting API, Fivestar)
Comments & change suggestions
Update subscription options:Subscribe (Messaging and Notifications framework)
RSS (views)
LEVERAGING COMMUNITIESUser driven assembly and export
Bookmark relevant documentation topics
Create a new DITA map in the GUI
Export the map and the topics it contains
LEVERAGING COMMUNITIESAssembly toolbox
Build DITA map using Graphmind mindmap UIDrag and drop
Build and execute queries from ViewsBuild custom queries from a GUI (Views)
Execute queries in Graphmind
ExportTo pdf, xhtml, online help with the DITA Open Toolkit
Export DITA topics and map
LEVERAGING COMMUNITIESKristof Van TommePRONOVIX
