I'm using this page as a working area for me to organize thoughts, a place to jot down ideas for a higher level strategy for how to manage the documentation and knowledge for this project. 

I've used an acronym "STACK" to easily and quickly get a project organized for client projects. Eventually this is used also as a super structure for the knowledge management. 

This article I wrote recently has some of the ideas which I'll be leveraging on this page: https://blog.anant.us/part-2-foundation-for-properly-managing-a-business-data-communications-framework/



SetupTrainingAdministrationConfigurationKnowledge Management
Developer
  • Install
  • Automation
  • Implementation Training
  • Continuous testing
  • Continuous testing
  • Self Service process
  • Platform Implementation Guide
Administrator
  • Install
  • Automation
  • Stress Test
  • Orchestration Automation
  • Continuous Integration & Delivery
  • Operations Training
  • Continuous monitoring
  • Incident management
  • Data / Disaster Recovery Plan
  • Testing environments
  • Platform Operations Runbook
  • Issue resolution knowledge
Architect
  • Understanding the current/future needs
  • Mapping a next viable architecture
  • Deciding on Infrastructure
  • Curriculum Planning
  • Architecture Training
  • Service management
  • Service transition
  • Service transition
  • Service strategy
  • Change management
  • Platform Architecture

Another approach I've taken is to use the Goal Directed Design methodology from Alan Cooper to focus on the personas and their goals. 


DeveloperAdministratorArchitect
Audience DefinitionA developer who has basic knowledge of databases. Someone who has some knowledge of SQL / noSQL and is exposed to SQL before.Someone who has basic experience administrating Linux servers and preferably Linux based databases.Someone who's designing scalable platforms. 
Primary Goals


Primary Non-Goals


Documentation Inventory (In progress)

Documentation ArtifactSourcePublishedPurposeAudienceProcessNotes
Confluence: CASSANDRAhttps://cwiki.apache.org/confluence/display/CASSANDRA/HomeSameMain wiki for the Apache Cassandra Project
Confluence edits.Fairly easy to contribute.
Confluence: CASSANDRA2https://cwiki.apache.org/confluence/display/CASSANDRA2/HomeSameImported wiki for the Apache Cassandra Project
Imported from old wiki?Need to clean this as we fill out primary WIKI
Src.Doc: Websitehttps://svn.apache.org/repos/asf/cassandra/site/src/https://cassandra.apache.org/Apache Cassandra main website (dependent on nodetool binary)

Built using Jekyll. 

Must build cassandra first. 

Have to break the dependency on nodetool documentation. 

Too difficult to quickly help with the website. Unnecessary friction.

Src.Doc: Documentationhttps://github.com/apache/cassandra/tree/trunk/dochttps://cassandra.apache.org/doc/Apache Cassandra documentation (dependent on nodetool binary)

Build using Sphinx

Must build cassandra first. 

Have to break the dependency on nodetool documentation. 

Too difficult to quickly help with the website. Unnecessary friction.

Src.Doc: Nodetoolhttps://github.com/apache/cassandra/blob/trunk/doc/gen-nodetool-docs.pyhttps://cassandra.apache.org/doc/latest/tools/nodetool/Nodetool documentation (generated by nodetool binary)

Build using Nodetool output.

Then using python tool. 

Must build cassandra first. 









  • No labels