open-mbee / open-mbee.github.io Goto Github PK

The MMS documentation links on the wiki are outdated: https://github.com/Open-MBEE/open-mbee.github.io/wiki/OpenMBEE-documentation

The quickstart references the following commercial tooling

• Add Cameo Systems Modeler with Cameo MDK Quickstart.
• Add Mathematica with Mathematica MDK Quickstart.
• Add MATLAB with MATLAB MDK Quickstart.

We should be clear on what the expectations are for getting started with commercial tooling.

• medium
• instagram
• twitter
• LinkedIn
• facebook
• Licenses
• Governance
• clean up projects

transfer epic and tickets
https://openmbee.atlassian.net/browse/OMBEE-28

We are interested in restructuring the Flexo architecture so that it reads like an intuitive guide. An example of that is the Cassandra architecture documentation.

Cassandra architecture is broken down into the following

• Overview: abstract in nature, specifies the reason Cassandra was developed in the first place. Justifies it's existence.
• Dynamo: what architectural design principles (from 3rd party existing systems) motivated Cassandra's own architecture. Details "first class citizen" concepts/objects which provides the system functionality or are used within the system.
• Storage Engine: explains how storage is actually implemented in the database. For a relational database equivalent we would be talking about tables and their characteristics e.g. LOGGED/UNLOGGED and any other optimizations which can be applied to different use cases.
• Guarantees: references foundational computer science Consistency, Availability & Partitioning Tolerances (CAP) theory to easily communicate where Cassandra fits in and what it can be used for.

AWS's DynamoDB documentation provides another excellent example of straightforward, intuitive information which someone can engage with and educate themselves with before attempting to use the product. We need to do the same for OpenMBEE/Flexo.

We can use these as motivation for identifying what is missing from our architectural documentation.

The desired outcome from this task is for us to outline a structure for our architectural documentation and then create separate tickets which will deliver the documentation for each of those areas.

As OpenMBEE is a NumFOCUS sponsored project, we should add both the

• NumFOCUS project logo and
• sponsor attribution

We can ask on the NumFOCUS Slack as to using their logo and what attribution language looks like. It is also described at trademark-guidelines.

Currently, people create their own calendar entries or else learn from community events through the Google Group. That is fine but it is useful to be able to subscribe to calendar events or synchronize your existing (Outlook) calendar with the OpenMBEE community Google Calendar. I'll submit a PR for this.

It was suggested at an INCOSE-LA meeting that the OpenMBEE homepage should include a ConOps diagram, including stakeholders and example use cases.

The OpenMBEE project page on the NumFOCUS Website is convoluted, confusing and of little utility. It doesn't represent the OpenMBEE project well and we could do a much better job if it was simplified to focus on project features.
This ticket involves developing new content for the product pitch and then approaching NumFOCUS via their Slack channel in order to update the content.

The roadmap is outdated, confusing and ultimat4ly useless. We need to either update it or remove it entirely.

The Leadership page is pretty useless. Either we revise it to make it useful or remove it entirely.

The output from #44 can be used to create wireframes for the website design. We can use either figma or mural to host the designs such that people can see the proposed MVP before we put the website back together.

As part of OEP-1 we need to identify the problems users experience whilst using the OpenMBEE website.

This ticket will create a survey which will capture user feedback and allow us to derive actions for improving the website.

The survey will be created in Google Forms. The research participants will be the entire OpenMBEE #general slack channel.

Design Recommendations:

• User research
  • Characterize users (interviews and surveys) - what kinds of projects are they working on? how comfortable are they with open source and MBSE? what are their roles? how do they choose a technology? what key tasks do they need to complete on the website?
  • Characterize existing site (usability testing) - Can they complete their key tasks? Do they understand the navigation?
• UX Design
  • Website navigation (card sort) - What content structure makes the most sense to users of different categories?
  • User Feedback (usability testing) - Create wireframes and ask users to complete key tasks. If they struggle, iterate on the wireframes
• Branding and visual design
  • Update look and feel - Update to make more appropriate for audience
  • Create or find new graphics for new content

https://openmbee.atlassian.net/wiki/spaces/OPENMBEE/pages/653754419/How+to+use+Jira+and+Github+tickets

#51 & #52 focus on the getting started guides for user and developers respectively. In this ticket however we will evaluate all of the other content on the OpenMBEE website and group it by user or developer.

User

• split out user resources from participate
• clean-up user guides

Developer

• Contributing guide
• split out developer resources from participate
• clean up projects documentation