diff options
-rw-r--r-- | doc/automatic-actions.markdown | 28 | ||||
-rw-r--r-- | doc/board-collapsed-expanded.markdown | 2 | ||||
-rw-r--r-- | doc/board-show-hide-columns.markdown | 2 | ||||
-rw-r--r-- | doc/creating-projects.markdown | 10 | ||||
-rw-r--r-- | doc/editing-projects.markdown | 14 | ||||
-rw-r--r-- | doc/es_ES/kanban-vs-todo-and-scrum.markdown | 2 | ||||
-rw-r--r-- | doc/kanban-vs-todo-and-scrum.markdown | 10 | ||||
-rw-r--r-- | doc/project-permissions.markdown | 12 | ||||
-rw-r--r-- | doc/project-views.markdown | 20 | ||||
-rw-r--r-- | doc/removing-projects.markdown | 4 | ||||
-rw-r--r-- | doc/sharing-projects.markdown | 16 | ||||
-rw-r--r-- | doc/usage-examples.markdown | 4 | ||||
-rw-r--r-- | doc/what-is-kanban.markdown | 20 |
13 files changed, 72 insertions, 72 deletions
diff --git a/doc/automatic-actions.markdown b/doc/automatic-actions.markdown index d109a95b..add62662 100644 --- a/doc/automatic-actions.markdown +++ b/doc/automatic-actions.markdown @@ -1,15 +1,15 @@ Automatic Actions ================= -To minimize the user interaction, Kanboard support automated actions. +To minimize user interaction, Kanboard support automated actions. -Each automatic action is defined like that: +Each automatic action is defined with these properties: - An event to listen -- Action linked to this event -- Eventually there is some parameters to define +- Action linked to the event +- Additional parameters -Each project has a different set of automatic actions, the configuration panel is located on the project listing page, just click on the link **Automatic actions**. +Each project has a different set of automatic actions. The configuration panel is located on the project listing page - just click on the link **Automatic actions**. Add a new action ---------------- @@ -18,19 +18,19 @@ Click on the link **Add a new automatic action**. ![Automatique action](screenshots/automatic-action-creation.png) -- Choose an action -- Then, select an event -- And finally, define the parameters +1. Choose an action +2. Select an event +3. Define the parameters -List of available actions +Available actions ------------------------- - Create a comment from an external provider - Add a comment log when moving the task between columns -- Assign automatically a category based on a color +- Automatically assign a category based on a color - Change the category based on an external label -- Assign automatically a category based on a link -- Assign automatically a color based on a category +- Automatically assign a category based on a link +- Automatically assign a color based on a category - Assign a color when the task is moved to a specific column - Change task color when using a specific task link - Assign a color to a specific user @@ -75,7 +75,7 @@ Here are some examples used in real life: ### When a task is completed, duplicate this task to another project -Let's say we have two projects "Customer orders" and "Production", once the order is validated, swap it to the "Production" project. +Let's say we have two projects: "Customer orders" and "Production". Once the order is validated, swap it to the "Production" project. - Choose action: **Duplicate the task to another project** - Choose the event: **Closing a task** @@ -83,7 +83,7 @@ Let's say we have two projects "Customer orders" and "Production", once the orde ### When a task is moved to the last column, move the exact same task to another project -Let's say we have two projects "Ideas" and "Development", once the idea is validated, swap it to the "Development" project. +Let's say we have two projects: "Ideas" and "Development". Once the idea is validated, swap it to the "Development" project. - Choose action: **Move the task to another project** - Choose the event: **Move a task to another column** diff --git a/doc/board-collapsed-expanded.markdown b/doc/board-collapsed-expanded.markdown index 0164da95..aeffcf10 100644 --- a/doc/board-collapsed-expanded.markdown +++ b/doc/board-collapsed-expanded.markdown @@ -9,7 +9,7 @@ Collapsed mode ![Tasks collapsed](screenshots/board-collapsed-mode.png) -- If the task is assigned to someone, the initials of the person are shown next to the task number +- If the task is assigned to someone, the initials of the person are shown next to the task number. - If the task title is too long, you can put your mouse over the task to show a tooltip with the full title. Expanded mode diff --git a/doc/board-show-hide-columns.markdown b/doc/board-show-hide-columns.markdown index 113298d3..0da2d28d 100644 --- a/doc/board-show-hide-columns.markdown +++ b/doc/board-show-hide-columns.markdown @@ -9,4 +9,4 @@ To hide a column, click on the column dropdown menu and choose "Hide this column ![Show a column](screenshots/show-column.png) -To show again the column, click on the "plus icon". +To show the column again, click on the "plus icon". diff --git a/doc/creating-projects.markdown b/doc/creating-projects.markdown index 373d93eb..05d5b20c 100644 --- a/doc/creating-projects.markdown +++ b/doc/creating-projects.markdown @@ -16,24 +16,24 @@ From the dashboard, click on the link **New project**: ![Project creation form](screenshots/new-project.png) -It's very easy, you just have to find a name for your project! +It's very easy: you just have to find a name for your project! Creating a private project -------------------------- -- Everybody can create a private project +- Anybody can create a private project - There is **NO** user management -- Only the owner and administrators can access to the project +- Only the owner and administrators can access the project From the dashboard, click on the link **New private project**. Creating projects from another project -------------------------------------- -When you create a new project, your can choose to duplicate the properties of another project : +When you create a new project, you can choose to duplicate the properties of another project: - Permissions - Actions - Swimlanes -- Catégories +- Categories - Tasks diff --git a/doc/editing-projects.markdown b/doc/editing-projects.markdown index e7fea212..c9c1a5a0 100644 --- a/doc/editing-projects.markdown +++ b/doc/editing-projects.markdown @@ -1,15 +1,15 @@ Editing Projects ================ -Projects can be renamed and disabled at any time. +Projects can be renamed or disabled at any time. -To rename a project, just click on the link "Edit project" on the left. +To rename a project, just click on the link entitled "Edit project" on the left. ![Project edition](screenshots/project-edition.png) -- The start date and end date are used to generate the project Gantt chart -- The description is visible as tooltip on the board and on the projects listing page -- Administrators and project administrators can convert a private project to multiple users project by changing the checkbox "Private project". -- You can also convert multiple users project to a private project. +- The start date and end date are used to generate the project Gantt chart. +- The description is visible as a tooltip on the board and on the projects listing page. +- Administrators and project administrators can convert a private project to a multiple-user project by changing the checkbox "Private project". +- You can also convert a multiple-user project to a private project. -Note: When you make a project private, all existing users will still have access to the project. Adjust the list of users according to your needs. +Note: When you make a project private, all existing users will still have access to the project. You can adjust the list of users according to your needs. diff --git a/doc/es_ES/kanban-vs-todo-and-scrum.markdown b/doc/es_ES/kanban-vs-todo-and-scrum.markdown index 6e8d9e6c..5295a6d1 100644 --- a/doc/es_ES/kanban-vs-todo-and-scrum.markdown +++ b/doc/es_ES/kanban-vs-todo-and-scrum.markdown @@ -11,7 +11,7 @@ Kanban vs Todo lists ### Kanban: -- Multi fases, +- Multi fases, - Concentración absoluta para evitar multitareas por que se puede establecer un limite por columna para mejorar el progreso diff --git a/doc/kanban-vs-todo-and-scrum.markdown b/doc/kanban-vs-todo-and-scrum.markdown index 4e083ff8..ea97811c 100644 --- a/doc/kanban-vs-todo-and-scrum.markdown +++ b/doc/kanban-vs-todo-and-scrum.markdown @@ -11,8 +11,8 @@ Kanban vs Todo lists ### Kanban: -- Multiple phases, each column represent a step -- Bring focus and avoid multitasking because you can set a work in progress limit per column +- Multiple phases, each column represents a step +- Bring focus and avoid multitasking by setting a work-in-progress limit per column Kanban vs Scrum --------------- @@ -23,15 +23,15 @@ Kanban vs Scrum - Do not allow changes during the iteration - Estimation is required - Uses velocity as default metric -- Scrum board is cleared between each sprint +- Scrum board is cleared between sprints - Scrum has pre-defined roles like scrum master, product owners and the team - A lot of meetings: planning, backlogs grooming, daily stand-up, retrospective ### Kanban: - Continuous flow -- Changes can be made at anytime +- Changes can be made at any time - Estimation is optional - Use lead and cycle time to measure performance - Kanban board is persistent -- Kanban doesn't impose strict constraints or meetings, process is more flexible +- Kanban doesn't impose strict constraints or meetings; process is more flexible diff --git a/doc/project-permissions.markdown b/doc/project-permissions.markdown index 16586bc6..99e4caa2 100644 --- a/doc/project-permissions.markdown +++ b/doc/project-permissions.markdown @@ -1,8 +1,8 @@ Project Permissions =================== -Each project is isolated and compartmented from each other. -The project access must be allowed by the project owner. +Each project is isolated from other projects. +Project access must be allowed by the project owner. Each user and each group can have a different role assigned. There are 3 types of [roles for projects](roles.markdown): @@ -13,11 +13,11 @@ There are 3 types of [roles for projects](roles.markdown): Only administrators have access to everything. -Roles assignation is available from **Project Settings > Permissions**: +Role assignments are visible in **Project Settings > Permissions**: ![Project Permissions](screenshots/project-permissions.png) -If you choose to allow everybody, all Kanboard users will be considered Project Member. -That also means there is no role management anymore. Permission per user or per group cannot be applied. +If you choose to allow everybody, all Kanboard users will be considered 'Project Member'. +With this setting, role management will have no effect. Permission per user or per group cannot be applied. -Private projects cannot define permission. +Private projects cannot define permissions. diff --git a/doc/project-views.markdown b/doc/project-views.markdown index 19284407..f700055e 100644 --- a/doc/project-views.markdown +++ b/doc/project-views.markdown @@ -10,7 +10,7 @@ Board View ![Board view](screenshots/board-view.png) -- With this view you can drag and drop tasks between columns easily. +- With this view, you can drag and drop tasks between columns easily. - You can also use the keyboard shortcut **"v b"** to switch to the board view. - Tasks with a shadow are recently modified. @@ -25,7 +25,7 @@ Calendar View ![Calendar view](screenshots/calendar-view.png) -- With this view you can visualize tasks with a due date. +- With this view, you can visualize tasks with a due date. - Depending of the settings, you can also see tasks in progress. - You can also use the keyboard shortcut **"v c"** to switch to the calendar view. - [Learn more about calendar configuration](calendar-configuration.markdown) @@ -35,7 +35,7 @@ List View ![List view](screenshots/list-view.png) -- With this view all results of your search are displayed in a table. +- With this view, all results of your search are displayed in a table. - You can also use the keyboard shortcut **"v l"** to switch to the list view. Gantt View @@ -43,16 +43,16 @@ Gantt View ![Gantt view](screenshots/gantt-view.png) -- The Gantt view displays tasks on a horizontal timeline -- The start date and the due date are used to display the chart -- For quick access, use the keyboard shortcut: **v g** +- The Gantt view displays tasks on a horizontal timeline. +- The start date and the due date are used to display the chart. +- For quick access, use the keyboard shortcut: **v g**. Project Overview ---------------- ![Project overview](screenshots/project-view.png) -- View the description of the project -- Attach and upload documents to the project -- View list of project members -- View the last activities of the project +- View the description of the project. +- Attach and upload documents to the project. +- View list of project members. +- View the last activities of the project. diff --git a/doc/removing-projects.markdown b/doc/removing-projects.markdown index f9e622cb..0c4c5f36 100644 --- a/doc/removing-projects.markdown +++ b/doc/removing-projects.markdown @@ -1,10 +1,10 @@ Removing Projects ================= -To remove a project, you must be manager of the project or administrator. +To remove a project, you must be the manager of the project or an administrator. Go to the **"Project settings"**, and from the menu on the left, at the bottom, choose **"Remove"**. ![Removing Projects](screenshots/project-remove.png) -Removing a project remove all tasks that belongs to this project. +Removing a project removes all tasks that belong to this project. diff --git a/doc/sharing-projects.markdown b/doc/sharing-projects.markdown index 614c3230..400f7cb4 100644 --- a/doc/sharing-projects.markdown +++ b/doc/sharing-projects.markdown @@ -1,13 +1,13 @@ Sharing boards and tasks ======================== -By default, boards are private but it's possible to make a board public. +By default, boards are private, but it's possible to make a board public. -A public board **cannot be modified, it's a read-only access**. -This access is protected by a random token, only people who have the right URL can see the board. +A public board **cannot be modified: it has read-only access**. +Access is protected by a random token. Only people who have the right URL can see the board. Public boards are automatically refreshed every 60 seconds. -Task details are also available in read-only. +Task details are also available in read-only mode. Usage examples: @@ -21,7 +21,7 @@ Select your project, then click on "Public access" and finally click on the butt ![Enable public access](screenshots/project-enable-sharing.png) -When the public access is enabled, a couple of links are generated: +When public access is enabled, a couple of links are generated: - Public board view - RSS feed subscription link @@ -29,7 +29,7 @@ When the public access is enabled, a couple of links are generated: ![Disable public access](screenshots/project-disable-sharing.png) -You can also disable the public access whenever you want. +You can also disable public access whenever you want. -Each time, you enable or disable the public access a new random token is generated. -**The previous links will not work anymore**. +Each time you enable or disable public access, a new random token is generated. +**The previous links will not work anymore**! diff --git a/doc/usage-examples.markdown b/doc/usage-examples.markdown index 5efc6f9a..c200e082 100644 --- a/doc/usage-examples.markdown +++ b/doc/usage-examples.markdown @@ -8,7 +8,7 @@ Software development - Backlog - Ready -- Work in progress +- Work-in-progress - To be validated - Validated - Deployed in production @@ -18,7 +18,7 @@ Bug tracking - Reported - Confirmed -- Work in progress +- Work-in-progress - Tested - Fixed diff --git a/doc/what-is-kanban.markdown b/doc/what-is-kanban.markdown index 5d2eed02..de8377b2 100644 --- a/doc/what-is-kanban.markdown +++ b/doc/what-is-kanban.markdown @@ -11,22 +11,22 @@ There are only two constraints imposed by Kanban: Visualize your workflow ----------------------- -- Your work is displayed on a board, you have a clear overview of your project +- Your work is displayed on a board so that you have a clear overview of your project - Each column represents a step in your workflow -Bring focus and avoid multitasking +Limit your work in progress ---------------------------------- - -- Each phase can have a work in progress limits -- Limits are great to identify bottlenecks +- Encourages focus by avoiding multitasking +- Each phase can have work-in-progress limits +- Limits help identify bottlenecks - Limits avoid working on too many tasks at the same time -Measure performance and improvement ------------------------------------ +Performance Measurement +======================= Kanban uses lead and cycle times to measure performance: -- **Lead time**: Time between the task is created and completed -- **Cycle time**: Time between the task is started and completed +- **Lead time**: Time between task creation and completion +- **Cycle time**: Time between task start and completion -For example, you may have a lead time of 100 days and only have to work 1 hour to complete the task. +For example, you may have a lead time of 100 days but only have to work 1 hour to complete the task. |