Skip to content

Commit

Permalink
Handbook update (#45)
Browse files Browse the repository at this point in the history
* Additional cartography guidelines

I have added a few rules based on feedback for the Simple Africa map exercise and some from cartography class.

* Add files via upload

* Update daily_workflow.md

Added description on activity, task and project
Added section for planning sheet
Added section for burndown chart

---------

Co-authored-by: Tim Sutton <[email protected]>
  • Loading branch information
LunaAsefaw and timlinux authored Sep 27, 2023
1 parent cad67f2 commit ee71425
Show file tree
Hide file tree
Showing 7 changed files with 33 additions and 3 deletions.
29 changes: 27 additions & 2 deletions docs/src/company/kartoza/daily_workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

The activities for your day are determined by:


1. Which project you are working on, as listed in the company-wide project Gantt chart / sheet. Normally we try to have you work on a single project per day to reduce cognitive friction as you context switch from one project to another.
2. The scrum board / project board for that day's project. The list of sized tickets should be implemented sequentially, from the top of the 'This sprint' (or Ready or 'To-do') column, down to the bottom.

Expand Down Expand Up @@ -47,7 +48,7 @@ Here is an example from our Slack of a beautifully presented standup - yours sho

## Running your timesheets

We run our own timesheet application (thanks Dimas!) at [timesheets.kartoza.com](https://timesheets.kartoza.com/) - and in our ERP Next platform. The timesheets.kartoza.com is preferred since it has many niceties to make your time tracking more efficient. We bill our customers in 15 minute increments, rounded down or up as appropriate. This is aggregated across the day. That means if you e.g. log 2h12 minutes on one cost center for a client and 1h00 minutes on another cost center for the same client, the client will be billed 3h15min for the day's work.
We run our own timesheet application (thanks Dimas!) at [timesheets.kartoza.com](https://timesheets.kartoza.com/) - and in our ERP Next platform. The timesheets.kartoza.com is preferred since it has many niceties to make your time tracking more efficient. We bill our customers in 15-minute increments, rounded down or up as appropriate. This is aggregated across the day. That means if you e.g. log 2h12 minutes on one cost center for a client and 1h00 minutes on another cost center for the same client, the client will be billed 3h15min for the day's work.

The descriptions in your timesheets should be defensible, terse descriptions of work with links to GitHub issues. Defensible means that if a client were ever to ask you to justify how you spent your time in an invoiced line item, we can refer back to the description and see references to tickets worked on and the story points associated with the work.

Expand Down Expand Up @@ -79,10 +80,33 @@ Back on the timesheets app, in the form that appeared from the cog menu, enter y

![Register API](./img/timesheets-register-api.png)

Now use the button (1) to pull data from erpnext then the button (2) to return to your timesheet.
Now use button (1) to pull data from erpnext then button (2) to return to your timesheet.

![Register Complete](./img/timesheets-harvest.png)


## Completing your timesheet

Once you are logged in, you will see this interface:
![Interface](./img/Timesheet-interface.png)

The **Activity** dropdown has a list of activities, such as meetings, applied GIS work, coding, etc. This is a mandatory field and an option needs to be selected there to describe the type of activity being recorded.

The **Project** dropdown has a list of ongoing projects at Kartoza. If the activity being recorded is related to Kartoza, such as Admin tasks, or internal meetings such as All Hands meetings then this can be left blank and the system will automatically record it as Kartoza. However, if the task is related to a project, select a project from the dropdown.

The **Task** dropdown has a list of tasks pertaining to specific projects, this differs from project to project since the tasks will be broken down by high-level requirements so if the project requires development there would be a dropdown value 'Development/Implementation' but other projects might not need implementation. If you can't find the specific task you are doing, either look for the list and see what fits it (for example if the task you are recording is to discuss the data model with the client then you can select 'Modelling' from the list instead). However, if a task is crucial and missing from the list, contact Marina.

## View the Planning sheet
The planning sheet shows the schedule for the list of Kartoza members and the projects they are assigned to. This can be accessed by clicking on the cog menu and selecting 'Planning':
![Register Cog](./img/timesheets-register-cog.png)

Using this, you can see what projects are assigned to you for a specific period. Since projects will include various staff members, you can also find out who else is simultaneously assigned to the project in case you have queries or need to work on a task with someone and need their help.

## View the Burndown chart
The burndown chart provides information on how much time we have left to complete the project, how much time was allocated to a specific project and how much we have exceeded the allocated time if the project is not concluded on the specified deadline. This can be accessed by clicking on the cog menu and selecting 'Burndown Chart'.
![Register Cog](./img/timesheets-register-cog.png)


## Additional Guidelines

Developing a project can be a lot of fun and enjoyable to work together to make
Expand Down Expand Up @@ -265,3 +289,4 @@ manual entries etc. If, however, the ticket results in changes to workflows
- 🕵️Who can place tickets in this column?:
- 👩The customer.
- 🏉The project planner / scrum master

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 6 additions & 1 deletion docs/src/gis/cartography/cartography-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The relative size of your circles for process versus creative versus technical a

## Cartographic Map Design

### Reference : [Cartography n Map Design](https://en.wikipedia.org/wiki/Cartographic_design "Cartographic Map Design")
### Reference : [Cartography in Map Design](https://en.wikipedia.org/wiki/Cartographic_design "Cartographic Map Design")

**Definition.** Cartographic design or map design is the process of crafting the appearance of a map, applying the principles of design and knowledge of how maps are used to create a map that has both aesthetic appeal and practical function. It shares this dual goal with almost all forms of design; it also shares with other design, especially graphic design, the three skill sets of artistic talent, scientific reasoning, and technology. As a discipline, it integrates design, geography, and geographic information science.

Expand Down Expand Up @@ -167,6 +167,7 @@ Name | Description

## Common issues in cartography


No. | Before | Description | After |
----|-------|------------------------ |-------
1 | ![Overlapping Labels](img/labels-overlap-features-before.png) | Don't let labels overlap features. | ![Overlapping Labels](img/labels-overlap-features-after.png)
Expand Down Expand Up @@ -201,6 +202,10 @@ No. | Before | Description | After |
30 | ![icons](img/icon-before.png) | Make sure your symbols are consistent unless intentionally not consistent. Look at the size, colour and transparency of the symbols. | ![icons](img/icon-after.png)
31 | ![colour](img/colour-before.png) | When choosing colours for your map, and even your layout, first consider what the purpose of your map is and who is going to be looking at it. Does your map need to cater for colour-blind viewers or viewers with other visual impairments? What data are you representing? Are there colours associated with the data? Does your client have a style guide representing the colours they use? Consider all of these factors when styling your data as well as when you design your map layout. | ![colour](img/colour-after.png)
32 | ![stroke](img/stroke-size-before.png) | Be careful when adding defined outlines to your data while styling. Make sure the stroke width is not too thick or that the colour is not too pronounced. You can often get away with not having a defined stroke on your features, depending on the feature. | ![stroke](img/stroke-size-after.png)
33 | ![Suitable CRS](img/CRS.PNG) | Always use CRS that is suitable for the study area. Avoid CRS that distorts your study area.
34 | ![Callout crossing](img/label_crossing.PNG) | Avoid placing labels such that the callout crosses several other boundaries.
35 | ![Repetition](img/repetive.png) | Avoid repetition and unnecessary elements such as adding the word 'Legend' to the legend in situations where it is obvious.
36 | ![Sequential](img/sequential.PNG) | Avoid using a sequential color scheme when you have many categories since it makes it difficult to distinguish between categories, and use diverging, converging, or other schemes. For example, instead of light red to dark red, use red to blue.


[//]: # (This is a comment it wont be rendered if you leave a blank line after)
Expand Down
Binary file added docs/src/gis/cartography/img/CRS.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/gis/cartography/img/label_crossing.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/gis/cartography/img/repetive.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/gis/cartography/img/sequential.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ee71425

Please sign in to comment.