# HackMD as a Team Document Platform

## Basic Use Cases

left to right direction
skinparam actorStyle awesome
actor "Team Member" as team_member

rectangle "HackMD" {
    usecase "Share as Book Mode" as book_mode
    usecase "Share as Browse Mode" as browse_mode
    usecase "Share as Edit Mode" as edit_mode
    usecase "Share a Docment" as share_doc
    share_doc .d.> book_mode
    share_doc .d.> browse_mode
    share_doc .d.> edit_mode
    
    usecase "New a Document From Template" as create_from_template
    usecase "New a Document" as create_doc
    create_doc .l.> create_from_template 
    usecase "Search Document" as search_doc
}

team_member --> create_doc
team_member --> create_from_template
team_member --> share_doc
team_member --> search_doc: search tag and title

## Team Use Cases

left to right direction
skinparam actorStyle awesome
actor "Team Member" as team_member
actor "Outsider" as outsider

rectangle "HackMD" {
    rectangle "Personal Space" {
        usecase "Edit a Document" as edit_personal_doc
        usecase "Transfer Document Owner to Team Group" as transfer_owner
    }
    rectangle "Team Space" {
        usecase "View Shared Document" as view_shared_team_doc
        usecase "View Team Document" as view_team_doc
        usecase "Edit Team Document" as edit_team_doc
        usecase "Search Team Document" as search_team_doc
        usecase "Share a Document to outsider" as share_team_doc
        
        view_team_doc ..> view_shared_team_doc: share
    }
}
team_member --> edit_personal_doc: 1. edit document on your private space
team_member --> transfer_owner: 2. transfer the document to team
team_member --> view_team_doc
team_member --> edit_team_doc
team_member --> search_team_doc
team_member --> share_team_doc

outsider -r-> view_shared_team_doc

## Good Practices

### Create a Landing Page for a Group
Use the landing page as an entrypoint to store all the documents of the group.

### Add proper tag information in the document
Why this is important?
1. The first tag will show as category in the main page
2. HackMD only search `tag` and `title` if not enterprise version

How to add tags: (support autocompletion)

###### tags: `main_tag` `sub_tag1` `sub_tag2`

### Create good template to share with team members
- Chart Style templates
- Plantuml
- Mermaid
- Meeting minutes template