Skip to content

Commit b414e12

Browse files
committed
tweeks and links
1 parent 6485c53 commit b414e12

File tree

1 file changed

+77
-68
lines changed

1 file changed

+77
-68
lines changed

README.md

Lines changed: 77 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Hello everyone 👋,
44

5-
In this hard time we hope everyone is safe,
5+
In this hard time we hope everyone is safe.
66

77
As the global community is trying their best to solve this rapidly grown situation surrounding the spread of COVID-19. Governments and individuals alike are trying to keep people safe and to contain the spread, by social distancing and when possible just staying at home.
88

@@ -12,10 +12,10 @@ This is a small guide we wrote at Shieldfy to manage our work during the COVID-1
1212
1313
## Table of contents
1414

15-
* [Founders guide](#founders-guide)
16-
* [Team leader guide](#team-leaders-guide)
17-
* [Developer guide](#developers-guide)
18-
* [Tools & Services](#tools--services)
15+
* [Founders guide](#-founders-guide)
16+
* [Team leader guide](#-team-leaders-guide)
17+
* [Developer guide](#-developers-guide)
18+
* [Tools & Services](#-tools--services)
1919

2020

2121
## 👨‍💻 Founders guide
@@ -25,154 +25,163 @@ It's not an easy task but it's achievable, here are some tips for you.
2525

2626
1. **Embrace the pros more than the cons.**
2727

28-
It's very important for your team to feel that you are on board with the idea of being work remotely.
29-
This will give them the feeling that you trust them and gives them a sense of responsibility.
28+
It's very important for your team to feel that you are on board with the idea of being work remotely.
29+
This will give them the feeling that you trust them and gives them a sense of responsibility.
3030

3131

3232
2. **Re-organize your goals & KPIs**.
3333

34-
You have to rewrite your goals to be fit in short periods.
34+
You have to rewrite your goals to be fit in short periods.
3535

36-
You must be very sharp on what you need to accomplish. It needs to be specifically metered with numbers (KPI).
36+
You must be very sharp on what you need to accomplish. It needs to be specifically metered with numbers (KPI).
3737

38-
Also, it's very important to communicate these numbers and KPIs with your team, they must understand how their work contributes to company growth.
38+
Also, it's very important to communicate these numbers and KPIs with your team, they must understand how their work contributes to company growth.
39+
40+
`Tools used:` [Trello](https://trello.com)
3941

4042
3. **Your employees are your real capital, don't lose them**.
4143

42-
I know it's a hard time, You may have to cut your costs to extend your runway.
44+
I know it's a hard time, You may have to cut your costs to extend your runway.
4345

44-
The obvious choice will be layoff employees. Believe me, that is the most terrible choice you will have to make.
46+
The obvious choice will be layoff employees. Believe me, that is the most terrible choice you will have to make.
4547

46-
This will harm your employees in these hard times, and make the remaining employees feel insecure and feels betrayed by you. Their bond with each other is much stronger than your bond with them.
48+
This will harm your employees in these hard times, and make the remaining employees feel insecure and feels betrayed by you. Their bond with each other is much stronger than your bond with them.
4749

48-
> Stand with your employees not against them.
50+
> Stand with your employees not against them.
4951
50-
Instead, you can cut your costs from other resources (office, online/offline services .. etc). Also, you can communicate with your employees to reduce their salaries in this period instead of letting some of them go and they will be rewarded later.
52+
Instead, you can cut your costs from other resources (office, online/offline services .. etc). Also, you can communicate with your employees to reduce their salaries in this period instead of letting some of them go and they will be rewarded later.
5153

5254

5355
4. **Be transparent.**
5456

55-
Transparency in this specific time is needed more than ever. Your team already knows that we are facing a hard time. So communicate with them, explain your plan and company situation. Ask for their help and they will respond, It's their company too.
57+
Transparency in this specific time is needed more than ever. Your team already knows that we are facing a hard time. So communicate with them, explain your plan and company situation. Ask for their help and they will respond, It's their company too.
5658

5759
## 👨‍💻 Team leaders guide
5860

5961
1. **Communicate, communicate and communicate.**
6062

61-
Communication is the key, You have to communicate regularly with your team ( at least 2 times a day ). This will keep you sync with your team, who's working on what.
63+
Communication is the key, You have to communicate regularly with your team ( at least 2 times a day ). This will keep you sync with your team, who's working on what.
6264

63-
It depends on your methodology, but you can start the day with a standup meeting, and you can have a 1:1 catchup call with your team and ending the day with a quick recap.
65+
It depends on your methodology, but you can start the day with a standup meeting, and you can have a 1:1 catchup call with your team and ending the day with a quick recap.
6466

65-
> important note: Keep the meeting short (10-15 min) unless you have a good reason to make it long.
67+
> important note: Keep the meeting short (10-15 min) unless you have a good reason to make it long.
6668
67-
Tools used: `Google Meet`, `Slack`
69+
`Tools used:` [Google Meet](https://meet.google.com), [Slack](https://slack.com)
6870

6971

7072
2. **Understand the anatomy of working at home.**
7173

72-
Working from home is boring, distracting. You have to understand that in order to give your team reasonable tasks to finish.
74+
Working from home is boring, distracting. You have to understand that in order to give your team reasonable tasks to finish.
7375

74-
Perfect tasks are well written short stories
76+
Perfect tasks are well written short stories
7577

76-
Don't calculate the working time as a bulk. No one will set for 6-8 hours straight even at the office.
78+
Don't calculate the working time as a bulk. No one will set for 6-8 hours straight even at the office.
7779

78-
Instead, define a time ( 1-2 hours) that all the team should be online together and the rest of the day make it flexible for them.
80+
Instead, define a time ( 1-2 hours) that all the team should be online together and the rest of the day make it flexible for them.
7981

80-
Express to your team that it's ok if the kids' sounds appear in the meetings. Don't push your team members to be angry ( Family always first ).
82+
Express to your team that it's ok if the kids' sounds appear in the meetings. Don't push your team members to be angry ( Family always first ).
8183

8284
3. **More carrots, less stick.**
8385

84-
It's very normal to see a drop in productivity, especially in the first week or two. Please don't rush and punish your team for that.
86+
It's very normal to see a drop in productivity, especially in the first week or two. Please don't rush and punish your team for that.
8587

86-
Instead, try to award them for good work. It's always paid off to show them how you appreciate their hard work.
88+
Instead, try to award them for good work. It's always paid off to show them how you appreciate their hard work.
8789

88-
Tools used: slack, phone, be creative.
90+
`Tools used:` [Slack](https://slack.com), phone, be creative 😉 .
8991

9092
4. **Automate everything.**
9193

92-
As said before, the productivity is dropped. and human errors will be much higher. So in order to maintain the quality of your product, you must automate everything that can be automated.
93-
94-
Automate your code review: You can use tools like `code linters` and services like `Sonarqube` and `Shieldfy` to automate the code review for you. This helps you to identify problems fast and improve your workflow.
94+
As said before, the productivity is dropped. and human errors will be much higher. So in order to maintain the quality of your product, you must automate everything that can be automated.
9595

96-
Automate your deployment: If you don't have that yet, please do it fast. Make it Push to deploy for your test, development or staging environment. Allow developers to deploy their code without getting back to you.
96+
Automate your code review: You can use tools like `code linters` and services like `Sonarqube` and `Shieldfy` to automate the code review for you. This helps you to identify problems fast and improve your workflow.
9797

98+
Automate your deployment: If you don't have that yet, please do it fast. Make it Push to deploy for your test, development or staging environment. Allow developers to deploy their code without getting back to you.
9899

99-
Tools used: Github actions, Sonarqube, Shieldfy
100+
`Tools used:` [Github actions](https://github.com/feature/actions), [Sonarqube](http://sonarqube.org/), [Shieldfy](https://shieldfy.io)
100101

101102

102103
5. **Create developer handbook**
103104

104-
Create a handbook and describe all the processes of the development, QA and deployment.
105-
Try to describe everything in steps. This allows developers to act fast without asking you about everything.
105+
Create a handbook and describe all the processes of the development, QA and deployment.
106+
Try to describe everything in steps. This allows developers to act fast without asking you about everything.
106107

107-
Tools used: Github, Markdown
108+
`Tools used:` [Github](https://github.com), Markdown
108109

109110

110111
## 👨‍💻 Developers guide
111112

112113
1. **You are not at home, you are at work inside your home.**
113114

114-
The first thing to do is to define a corner at your home and set up your disk, chair, and PC.
115+
The first thing to do is to define a corner at your home and set up your disk, chair, and PC.
115116

116-
It's important to make it organized and looks like a professional desk like you have at work.
117+
It's important to make it organized and looks like a professional desk like you have at work.
117118

118-
> Don't ever make your default work from bed or couch
119+
> Don't ever make your default work from bed or couch
119120
120-
Tell your family that you are at work and you need to focus. And reward them later with quality fun time with them, they deserve it.
121+
Tell your family that you are at work and you need to focus. And reward them later with quality fun time with them, they deserve it.
121122

122123
2. **Communicate, communicate and communicate.**
123124

124-
Communicate with your team leader and your fellow developers on a regular basis.
125+
Communicate with your team leader and your fellow developers on a regular basis.
126+
127+
`Tools used:` [Google Meet](https://meet.google.com), [Slack](https://slack.com)
128+
125129

126130
3. **Divide your time, but still be connected.**
127131

128-
Don't imagine that you will spend 6-8 hours on your PC, this is home at the end. Instead, be realistic and take a break with your family (ex: 15 min every 2-3 hours).
132+
Don't imagine that you will spend 6-8 hours on your PC, this is home at the end. Instead, be realistic and take a break with your family (ex: 15 min every 2-3 hours).
129133

130-
But don't turn the notification off during these short breaks. Always be connected.
134+
But don't turn the notification off during these short breaks. Always be connected.
131135

132136

133137
## 🔧 Tools & Services
134138

135139
> note: we didn't list everything here, there is a lot of tools in the market, we just listed the tools we used and one or more similar product.
136140
141+
> In communications: we are using `Zoom`, `Google meet`, `Slack`, `Clubhouse`, `Trello` and `Loom`.
142+
143+
> In technical automation: we are using `Github`, `Github action`, `Shieldfy`, `SonarQube`, `Sentry`.
144+
137145
1. Visual Communication (Meetings)
138-
- Zoom
139-
- Google Meet
146+
- [Zoom](https://zoom.us)
147+
- [Google Meet](https://meet.google.com)
140148
2. All-day communication
141-
- Slack
149+
- [Slack](https://slack.com)
142150
3. Task management
143-
- Jira
144-
- Clubhouse
145-
- Asana
146-
- Trello
151+
- [Jira](https://www.atlassian.com/software/jira)
152+
- [Clubhouse](https://clubhouse.com)
153+
- [Asana](https://asana.com)
154+
- [Trello](https://trello.com)
147155
4. Visual Feedback
148-
- Loom
156+
- [Loom](https://loom.com)
149157
5. Source Code management
150-
- Github
151-
- Gitlab
152-
- Bitbucket
158+
- [Github](https://github.com)
159+
- [Gitlab](https://gitlab.com)
160+
- [Bitbucket](https://bitbucket.org)
153161
6. CI/CD
154-
- Github Actions
155-
- CircleCI
162+
- [Github Actions](https://github.com/features/action)
163+
- [CircleCI](https://circleci.com)
156164
7. Code review
157-
- linters (based on your programming language)
158-
- Code Climate
159-
- Codacy
160-
- SonarQube
165+
- linters
166+
- [Code Climate](https://codeclimate.com)
167+
- [Codacy](https://codacy.com)
168+
- [SonarQube](http://sonarqube.org)
161169
7. Security review
162-
- Shieldfy
163-
- Snyk
170+
- [Shieldfy](https://shieldfy.io)
171+
- [Snyk](https://snyk.io)
164172
9. Code coverage
165-
- CodeCov
166-
- Coveralls
173+
- CLI based code coverage
174+
- [Codecov](https://codecov.io)
175+
- [Coveralls](http://coveralls.io)
167176
10. Error tracking
168-
- Sentry
169-
- Rollbar
177+
- [Sentry](https://sentry.io)
178+
- [Rollbar](http://rollbar.com)
179+
170180

171-
172181
## 🤝 Contributing
173182

174183
Contributions, issues, and feature requests are welcome.
175184
You can open Issue first to have your suggestion discussed before you actually create a PR.
176185

177186

178-
## 🙏 Stay Home, Stay Safe
187+
## 🙏 Stay Home, Stay Safe

0 commit comments

Comments
 (0)