Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc Site Content Structure #3

Open
MrCoder opened this issue Oct 23, 2023 · 2 comments
Open

Doc Site Content Structure #3

MrCoder opened this issue Oct 23, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation Medium Priority High

Comments

@MrCoder
Copy link
Contributor

MrCoder commented Oct 23, 2023

Get Started

Syntax with examples

This section provides practical tutorial on ZenUML DSL with inline playground.

FAQs

General

  1. Is there a license applied on the generated content
  2. Is ZenUML Open source
  3. What is the roadmap of the products

Elements on the diagram

Message

  1. Fundamentals and Standards
  2. What is the difference between Sync messages and Async messages
  3. How to change the style of a message
  4. How to draw a reply message (3 ways)

Participant

  1. Fundamentals and Standards
  2. How to change the colour of a participant
  3. How to assign icons to a participant
  4. How to change the order of participants

Fragments (Alt, Opt, Loop, etc.)

  1. Fundamentals and Standards
  2. What is the difference between Alt and Opt

Tools

  1. What is the difference between ZenUML and Sequence Diagrams using PlantUML, SequenceDiagram.org, WebSequenceDiagrams.com and Mermaid
  2. How to share my diagram
  3. How to export my data

Products

  1. Web App
  2. Confluence Plugin
  3. JetBrains Plugin
  4. Desktop
  5. Chrome Extension

Examples

  1. Online Shopping
  2. Library
  3. Registration and Login
  4. Car Rental
  5. Loop, Alt
@unimu-cic
Copy link
Contributor

Do we need to include the fundamentals of UML, such as its elements? If so, we can consider adding 'How-Tos' to the basics. For instance:

  • Message
    • Fundamentals or Standards
    • How to change the style of a message
    • How to draw a reply message (in 3 different ways)
  • Participant
    • Fundamentals or Standards
    • How to change the color of a participant
    • How to assign icons to a participant

Everything mentioned above pertains to the fundamentals of UML or ZenUML's standards. However, if we aim to provide user guidance on specific features like exporting or sharing, step-by-step onboarding tours may prove more effective than extensive documentation. 🤔

@MrCoder
Copy link
Contributor Author

MrCoder commented Oct 24, 2023

Our goal is to become THE best source of information about Sequence Diagram.

我们的目标是变成人们获取关于序列图的知识的时候的goto的地方。这不仅是从SEO和导流的角度考量的,而且应当切实的提供最有效的知识。

所以,有关Sequence Diagram的基础知识和标准,我们肯定是要覆盖的。我们要特别注意易读性。我们当然不能按照UML标准去叙述,因为那个太枯燥了。你上面按照元素分列章节是一个方法。还有两个比较好的参照对象:https://www.uml-diagrams.org/sequence-diagrams.html,https://martinfowler.com/books/uml.html。

@MrCoder MrCoder added Medium Priority High documentation Improvements or additions to documentation labels Oct 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Medium Priority High
Projects
None yet
Development

No branches or pull requests

3 participants