User stories : documentation & collaboration

<<< Back to [[Final soa model design]]

CXXXXX (or others ?) - SOA Design doc

Informal design doc :

• As a business analyst / end user collaborating on design, I want to see and contribute on all of informal design SOA doc (& its changes...), be it on processes or interfaces (user or technical i.e. services), using text processor / spreadsheets / slides / images, so I can provide the business point of view
• As a developer collaborating on design, I want a wiki and HTML edition, so I can easily contribute service definition documentation

As a process analyst collaborating on design, I want to easily provide formal process definitions from their design tools

As a developer collaborating on design,

• I want support of main service types (SOAP and possibly JAXWS, REST / JAXRS, any HTTP REST), so I can use EasySOA in common SOA use cases
• I want to easily provide EasySOA with main service types' interfaces (SOAP and possibly JAXWS, REST / JAXRS, possibly SPoRE on client side), so I can define and maintain them
  • => upload, from source code URL (HTTP or SCM) (or generation to source code) ?

Design doc :

• business view (doc structure),
• business requirements (informal doc),
• formal expectations / rules (autodoc)

CXXXXX (or others ?) - SOA Development doc

As a developer of a service consumer,

• I want to have documentation about how to depend from a deliverable (maven : artifact, repo) in my project
• I want to have documentation about how to deploy a deliverable (maven) set on my development platform
• I want to see all development SOA doc, be it manually entered or generated from (Java, WSDL) code

As a developer of a service implementation,

• I want to easily contribute manual documentation about those 3 on SOA deliverables (ex. on a deliverable about its services implementations, but also on group / package)

As a Java developer of a service consumer,

• I want to be able to tag a System as being a "proxy" / "connector" and by its technology (ex. Java), so that when I ask about a way to use (consume) in Java) a service consumed by such a "proxy" System, EasySOA will answer with this System

Implementation doc :

• autodoc (wsdl/javadoc à la apidocserver),
• manual (doc about tech archi, algos, entry points à la github's Readme ; maybe also bigger granularity doc : packages / groups),
• deliverable info (how to access it / refer to it : maven repository...)

CXXXXX (or others ?) - SOA Deployment doc

As a developer / operator in deployment phase, I want to see all deployment / operation SOA doc

Deployment doc :

• how to deploy
• deployment parameters
• URL
• SLM
• ? SLA (endpoint can be modeled before it exists, see smarttravel / monitoring)

Further, doc branches out at all 3 levels to :

• Service Use Portal
• Expectations validation / sanity check dashboard / report