it:ad:documentation_services:home

IT:AD:Documentation Services

Documentation can/should be developed for any of the following:

  • Code (consider using a Wiki integrated in the Core Repository, but that only goes so far before you may need a running website to demo working code, such as API calls from JavaScript).
  • APIs (see above)
  • User Interface
  • [Internal] Support Processes



!includeurl http://skysigal.com/_media/resources/configuration/plantuml/minimalist.txt

'Optional:
'!includeurl http://skysigal.com/_media/resources/configuration/plantuml/icons_archimate.txt
'!includeurl http://skysigal.com/_media/resources/configuration/plantuml/icons_azure_cloud.txt
'!includeurl http://skysigal.com/_media/resources/configuration/plantuml/icons_bpm.txt
'!includeurl http://skysigal.com/_media/resources/configuration/plantuml/icons_ms_32.txt
'skinparam handwritten true
'<>
'<>
'<>
'<>
'<>
'skinparam nodesep 50
'skinparam ranksep 50
'skinparam dpi 300
'scale 0.8
'scale max 800 width

class Documentation

class Code
class APIs
class "User Experience" as UX
class "Support\nProcesses" as SP


Documentation o--> Code
Documentation o--> APIs
Documentation o--> UX
Documentation o--> SP

note bottom of Code
For Development
Specialist
Stakeholders
endnote

note bottom of APIs
For external
technical
Collaborator
Stakeholders
endnote

note bottom of UX
For Customer,
Business Service
and Customer
Support
Service
Stakeholders
endnote

note bottom of SP
For Business Service
and Customer Support
Service
Stakeholders
endnote




Code -[HIDDEN]RIGHT- APIs
APIs -[HIDDEN]RIGHT- UX
UX -[HIDDEN]RIGHT- SP




!includeurl http://skysigal.com/_media/resources/configuration/plantuml/minimalist.txt

'Optional:
'!includeurl http://skysigal.com/_media/resources/configuration/plantuml/icons_archimate.txt
'!includeurl http://skysigal.com/_media/resources/configuration/plantuml/icons_azure_cloud.txt
'!includeurl http://skysigal.com/_media/resources/configuration/plantuml/icons_bpm.txt
'!includeurl http://skysigal.com/_media/resources/configuration/plantuml/icons_ms_32.txt
'skinparam handwritten true


class "Support Processes\nDocumentation" as SP


class "Deployment" as SD
class "Testing" as ST
class "System Monitoring" as SM
class "User/Role Management" as UM

SP o--> UM
SP o--> ST
SP o--> SD
SP o--> SM

note bottom of SD
For System Services
Stakeholders
endnote

note bottom of ST
for Testing Service
Stakeholders
endnote

note bottom of SM
for System Support
Service
and
Security Service
Stakeholders
endnote


note bottom of UM
for Customer Support
Service
endnote