Skip to content
This repository has been archived by the owner on Apr 17, 2024. It is now read-only.

Commit

Permalink
Feature/gen-194 (#32)
Browse files Browse the repository at this point in the history
* feat: restructure everything

putting in recommended structure, while being mindful
of how we want to organize.

- lots of work on company section
- new guidelines for 1-1s
- some other clean ups
- add release checklist
- add release checklist procedure
- about handbook
- show more levels on sidebar
- remove dead pages, add copyright notice
- simplify title
  • Loading branch information
dave-at-koor committed Aug 17, 2023
1 parent d96b3a2 commit 6d6ba0c
Show file tree
Hide file tree
Showing 40 changed files with 496 additions and 138 deletions.
165 changes: 115 additions & 50 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -1,35 +1,43 @@
import { defineConfig } from 'vitepress'
import { defineConfig, DefaultTheme } from 'vitepress'
import { withMermaid } from 'vitepress-plugin-mermaid'

// https://vitepress.dev/reference/site-config
export default withMermaid(
defineConfig({
title: 'Koor Handbook',
title: 'Handbook',
titleTemplate: ':title | Koor Technologies, Inc.',
description: 'How we run our business',

lastUpdated: true,

head: [
['link', { rel: 'icon', type: 'image/x-icon', href: '/favicon.png' }],
],

themeConfig: {
// https://vitepress.dev/reference/default-theme-config
logo: 'koor-logo.png',

nav: [
{ text: 'Home', link: '/' },
{ text: 'Company', link: '/company/' },
{ text: 'Employees', link: '/employees/' },
{ text: 'Development', link: '/development/' },
{ text: 'Support', link: '/consulting/' },
{ text: 'Examples', link: '/markdown-examples' },
{ text: 'Development', link: '/engineering/development/' },
{ text: 'Product', link: '/engineering/product/' },
{ text: 'Marketing', link: '/marketing/' },
{ text: 'Support', link: '/customers/support/' },
],

sidebar: [
{
text: 'Company',
items: [
{ text: 'About', link: '/company/' },
{ text: 'Mission', link: '/company/mission' },
{ text: 'Vision', link: '/company/vision' },
{ text: 'About Koor', link: '/company/' },
{ text: 'Culture', link: '/company/culture' },
{ text: 'Communication', link: '/company/communication' },
{
text: 'Operating Procedures',
link: '/company/operating-procedures',
},
{
text: 'Goals',
link: '/company/goals/',
Expand All @@ -38,87 +46,139 @@ export default withMermaid(
text: '2023',
link: '/company/goals/annual2023',
},
{
text: 'June 2023',
link: '/company/goals/june2023',
},
{
text: 'July-Aug 2023',
link: '/company/goals/july-aug2023',
},
],
},
{
text: 'Marketing',
link: '/company/marketing/',
text: 'Employees',
items: [
{ text: 'Branding', link: '/company/marketing/branding' },
{
text: 'Social Media',
link: '/company/marketing/social-media',
},
{
text: 'Strategy for Adoption',
link: '/company/marketing/strategy-for-adoption',
},
{ text: 'Who Powers Koor', link: '/company/employees/' },
{ text: '1-on-1s', link: '/company/employees/1on1s' },
{ text: 'Performance', link: '/company/employees/performance' },
],
},
],
},
{
text: 'Employees',
items: [
{ text: 'Who Powers Koor', link: '/employees/' },
{ text: 'Performance', link: '/employees/performance' },
],
},
{
text: 'Development',
text: 'Engineering',
link: '/engineering/',
items: [
{
text: 'Product Roadmap',
link: '/development/product-roadmap',
text: 'Product Planning',
link: '/engineering/product/',
items: [
{
text: 'Product Roadmap',
link: '/engineering/product/product-roadmap',
},
],
},
{
text: 'Development',
items: [
{ text: 'Practices', link: '/engineering/development/' },
{
text: 'Release Management',
items: [
{
text: 'Procedures',
link: '/engineering/development/release-management',
},
{
text: 'Release Checklist',
link: '/engineering/development/release-checklist',
},
],
},
{
text: 'Infrastructure',
link: '/engineering/development/infrastructure',
},
],
},
{ text: 'Development Practices', link: '/development/' },
{
text: 'Release Management',
link: '/development/release-management',
text: 'Quality',
link: '/engineering/quality/',
},
{ text: 'Infrastructure', link: '/development/infrastructure' },
{
text: 'Demo System',
items: [
{
text: 'Overview',
link: '/development/demo/',
link: '/engineering/demo/',
},
{
text: 'Vision for Demo System',
link: '/development/demo/demo-system-mindmap',
link: '/engineering/demo/demo-system-mindmap',
},
{
text: '1st Impl Attempt',
link: '/development/demo/impl-notes-take-1',
link: '/engineering/demo/impl-notes-take-1',
},
],
},
{
text: 'System Operations',
link: '/engineering/systemops/',
},
],
},
{
text: 'Customer Success',
link: '/customers/',
items: [
{
text: 'Support',
link: '/customers/support/',
items: [
{ text: 'Tracking Hours', link: '/customers/support/tracking' },
{ text: 'Assessments', link: '/customers/support/assessments' },
{
text: 'Customer Calls',
link: '/customers/support/customer-calls',
},
{
text: 'Keeping in Touch',
link: '/customers/support/keeping-in-touch',
},
{
text: 'Performance Tuning',
link: '/customers/support/performance-tuning',
},
{
text: 'Troubleshooting',
link: '/customers/support/troubleshooting',
},
],
},
],
},
{
text: 'Support',
text: 'Marketing',
link: '/marketing/',
items: [
{ text: 'Consulting Practice', link: '/consulting/' },
{ text: 'Tracking Hours', link: '/consulting/tracking' },
{ text: 'Assessments', link: '/consulting/assessments' },
{ text: 'Customer Calls', link: '/consulting/customer-calls' },
{ text: 'Keeping in Touch', link: '/consulting/keeping-in-touch' },
{ text: 'Branding', link: '/marketing/branding' },
{
text: 'Performance Tuning',
link: '/consulting/performance-tuning',
text: 'Social Media',
link: '/marketing/social-media',
},
{
text: 'Strategy for Adoption',
link: '/marketing/strategy-for-adoption',
},
{ text: 'Troubleshooting', link: '/consulting/troubleshooting' },
],
},
{
text: 'Sales',
link: '/sales/',
},
{
text: 'Security',
link: '/security/',
},
],

socialLinks: [
Expand All @@ -129,6 +189,11 @@ export default withMermaid(
},
{ icon: 'twitter', link: 'https://twitter.com/koor_tech' },
],

footer: {
message: 'MIT License',
copyright: 'Copyright © 2022-present Koor Technologies, Inc.',
},
},
markdown: {
xhtmlOut: true,
Expand Down
12 changes: 12 additions & 0 deletions docs/bizops/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Business Operations
---

# Business Operations

## Finance: Accounting, payroll, expenses

## Tooling

## People Operations: Hiring, benefits, celebrations, gifts, departures

20 changes: 20 additions & 0 deletions docs/company/communication.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Communication
---

# Communication

## General guidelines


## Levels of confidentiality


## Internal communication


## Meetings


## Using Slack, email, video conferencing (Zoom / Meet / Jitsi)

59 changes: 59 additions & 0 deletions docs/company/culture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: Culture
outline: [2, 3]
---

# Culture

## Values


## Life at Koor


## Handbook

Koor is a fully remote company. That has a lot of advantages. To name one, we can bring the best talent the world has to offer wherever talented people have access to the Internet. For another, we save a lot of time we would otherwise waste commuting to and from an office.

A cornerstone that allows remote work to be effective is a handbook that is the single-source-of-truth for how we operate. You are reading the handbook now. If we have done a thorough and careful job, many questions are answered in these pages, saving people time in not having to repeat ourselves as new people come into the company, or we engage in a particular process for the first time, or we have to remember how to do that thing we don't do very often.

If you need further convincing that maintaining and depending on a common handbook is vital to running a remote company, [read this](https://about.gitlab.com/company/culture/all-remote/handbook-first-documentation).

### What goes in the handbook

The handbook is meant to include just about everything we do and how we do it. It may be easier to define what belongs here by listing what does not belong here. If something is not in the following list, perhaps the handbook is the best place for it.

**Things to put elsewhere**

- Technical documentation:
- Docs that explain how to use software (dev guide, API specs, etc.) we build should live in the software's source [repository](https://github.com/koor-tech).
- All other technical information and knowledge sharing goes in our [Knowledge Center](https://kb.koor.tech/).
- Design artifacts for released software belong in the Knowledge Center or source repo. Choose one and cross link from the other.
- Project work is tracked in Linear.
- Company Secrets
- We do have a few secrets, although the line between private and public information may be more lenient than you expect.
- Any related to system access - passwords, recovery keys, account numbers, and so on - should be stored in 1Password.
- We also have a private handbook. Ask if you think you need to see it.
- Customer information
- We never want to share or leak private information about our customers, primarily for their privacy, which is reason enough.
- Personnel information
- We also do not want to expose sensitive employee information. That belongs in our HR systems only.


### How to add content

This handbook is written primarily in markdown, which makes it easy for anyone to contribute. The pages are built into a static website by the VitePress framework. We can extend the framework as needed using VueJS, the JavaScript framework that VitePress is built on.

If you are on the less technical side of things, never mind any of that. Just write the content in a Linear issue, and buddy up with someone who can help get it into the mix.


## Rituals

- Watercooler - for social chatting (although work slips in from time to time).
- Demo Time - share something with the group, something you worked on, a bit of knowledge, someone cool that you found, a problem you are having, anything goes.
- Retrospectives - time to think about what is working and what might be improved.


## Team Stories


28 changes: 28 additions & 0 deletions docs/company/employees/1on1s.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: Weekly employee-manager 1-on-1 meetings
---

# Weekly employee-manager 1-on-1 meetings

## Purpose

Of the many good reasons to have 1-on-1s, we will focus on three.

First, one-on-ones are a time to reflect on recent accomplishments and to realign on the next set of challenges. They are also a good time to discuss work matters of a more individual or personal nature: career aspirations, performance feedback, general well-being, etc.

Second, one-on-ones provide an opportunity to chronicle the work you are doing as it is happening. It's a lot easier to remember what you have done with a weekly journal of what you have done.

Third, one-on-ones give you and your manager a chance to build your working relationship, to develop trust, and to help each other make better contributions to the company.


## General procedure

As a standard practice, each employee will meet with his or her manager on a weekly basis. The meeting will block a half-hour slot in the calendar. While it is fine to make full use of the time, the meeting can end once all of the topics are covered.

The calendar invite will include the recurring Meet or Zoom meeting and a shared Google document for 1-1 notes.

The employee can make this easier by preparing for the meeting. Before the meeting starts, open the shared notes and create a new heading with the meeting date. Copy the template, and answer the questions. It is okay to summarize, or add as much detail as needed to be clear.

When your notes are ready, you can @ notify your manager in the document. Giving your manager time to read the notes beforehand will either speed up the meeting or allow you to discuss matters more deeply. Also, it gives you time to remember additional points.

During the meeting, have the notes open and additional thoughts that come up.
Loading

0 comments on commit 6d6ba0c

Please sign in to comment.