search

DocOps / openstyles

Defines a framework and format for metadata-rich, automation-friendly style guides and glossaries.
6 stars 1 forks source link

First draft of user stories #3

Open briandominick opened 3 years ago

briandominick commented 3 years ago

I have quickly scribbled down some user stories just to get started on the functionality of this project. I am in no rush to merge this, and I'd be happy for others to review it or even add a commit. I'm not wedded to the style or even all of what's already there. I just wanted to seed definition of the project.

capsulecorplab commented 3 years ago

m30ml is a YAML-based modeling language specifically designed for capturing an architecture (i.e., references, stakeholder needs, user stories, data structures, and their relationships) in a docs-as-code manner, where the presentation/view can be controlled using asciidoc-flavored liquid templates. It's currently being used to define the spec for the Distributed Open-source Hardware Framework (DOF). Could be useful, if one or more of these user stories maps to one or more stakeholder needs and/or references. I can assist with formatting this PR to meet the m30ml spec, as well as setting up the automated workflow, if this approach makes sense for managing the open styles spec

briandominick commented 3 years ago

@capsulecorplab This project is very cool in a few ways that make me want to use it, but those are mainly my affinity for the stuff you highlighted -- the formating and tooling. It also seems very lightweight, which I quite like. Unfortunately, I'm not immediately able to grasp this in the form of an application, partly because I don't really understand what the OSHW stuff is (they don't seem to define it anywhere?). I think with some help I could grasp it, but the current docs and example aren't bridging it for me. If you want to put something together for this project that might model the whole thing for me, I'd be thrilled to check it out and try to make it work.

Short of that, I was thinking keep it simple, work on some basic user stories and turn them into issue tickets and get to work on them.

capsulecorplab commented 3 years ago

@briandominick OSHW is shorthand for open-source hardware. The doc should really spell out the abbreviation somewhere; I'll probably open an issue