socadk / design-practice-repository Goto Github PK

At present, the bibtex identifiers such as @Starke:2015 are not resolved.

Software Architecture:

• NFR specification (aka QAS and constraints)
• Architecture Overview Diagram
• Logical Component Model/Diagram, Operational Model/Deployment Diagram
• Arch. Refactoring Template, see https://www.infoq.com/articles/architectural-refactoring/ and http://rdcu.be/lFW6
• Information Architecture (data-centric view on system under construction: activity, artifact templates)

Agile practices and DDD:

• Story Splitting (for service/component identification)
• Story Mapping and other forms of BPM
• DDD: F-A-S-T bounded context types as supported in Context Mapper

API, SOA, MSA:

• Interface refactoring
• API review checklist
• API evolution and commercialization, see for instance "Continuous API Management: Making the Right Decisions in an Evolving Landscape"

See "future work" subfolder(s) for additional candidates and artifact-template stubs, as well as "Backlog of Missing Method Elements " in appendix of https://leanpub.com/dpr

Open

• [O] Web crawler for known uses/examples?

Done

• bibtex to markdown per page (there is a sample .bib file in the top folder)
• Evaluate and decide for tool and notation for process workflow diagrams
  • Describe as sequence of DDD events and translate into BPMN with SketchMiner?
• Add a postprocessor to turn "---" into mdash etc. https://daringfireball.net/projects/smartypants/
  • not needed, this works: —

Something like the subway map of the Agile Alliance would be great to have; we can start with something less sophisticated

• Caution: READMEs require separate treatment w.r.t links
  • add manually
  • remove relative links to repo sources under "More information"
• Copy top-level files, tutorials, artifacts, activities, roles, bibliography
• Move repo README to introduction.md (and folder-level ones need to be renamed too)
  • (in top-level folder) rm introduction.md and then mv README.md introduction.md
• Link to GitPages Home
  • (in activities folder) sed -i '9 i [Git Pages Home](https://socadk.github.io/design-practice-repository)' *.md and sed -i '10 i [Activities Overview](https://socadk.github.io/design-practice-repository/activities)' *.md and (optional) sed -i '9 i \\' *.md
  • (in artifact-templates folder) sed -i '8 i [Git Pages Home](https://socadk.github.io/design-practice-repository)' *.md and sed -i '9 i [Artifacts Overview](https://socadk.github.io/design-practice-repository/artifact-templates)' *.md and (optional) sed -i '8 i \\' *.md
  • (in roles folder) sed -i '5 i [Git Pages Home](https://socadk.github.io/design-practice-repository)' *.md and sed -i '6 i [Roles Overview](https://socadk.github.io/design-practice-repository/roles)' *.md and (optional) sed -i '5 i \\' *.md
• Check figures, adjust links:
  • (in activities folder) sed -i 's@/activities/@./@g' *.md
  • (in artifact-templates folder) sed -i 's@/artifact-templates/@./@g' *.md
  • Not needed yet: (in roles folder) sed -i 's@/roles/@./@g' *.md