Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,8 @@
"guides/navigation",
"guides/seo",
"guides/style-and-tone",
"guides/understand-your-audience"
"guides/understand-your-audience",
"guides/how-we-work"
]
},
{
Expand Down
40 changes: 40 additions & 0 deletions guides/how-we-work.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: "How we work"

Check warning on line 2 in guides/how-we-work.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/how-we-work.mdx#L2

Try to avoid using first-person plural like 'we'.
description: "Our team processes, development methodology, and communication practices."

Check warning on line 3 in guides/how-we-work.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/how-we-work.mdx#L3

Try to avoid using first-person plural like 'Our'.
---

## Team processes and workflows

Our team follows structured processes to ensure consistent, high-quality output:

Check warning on line 8 in guides/how-we-work.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/how-we-work.mdx#L8

Try to avoid using first-person plural like 'Our'.

- **Daily standups** - Brief sync meetings to share progress and blockers

Check warning on line 10 in guides/how-we-work.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/how-we-work.mdx#L10

Did you really mean 'standups'?
- **Weekly planning** - Review priorities and assign tasks for the upcoming week
- **Sprint retrospectives** - Reflect on what worked and what needs improvement
- **Documentation reviews** - All changes go through peer review before publishing

## Development methodology

We use an agile approach adapted to our documentation needs:

Check warning on line 17 in guides/how-we-work.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/how-we-work.mdx#L17

Try to avoid using first-person plural like 'We'.

Check warning on line 17 in guides/how-we-work.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/how-we-work.mdx#L17

Try to avoid using first-person plural like 'our'.

- **Iterative development** - Ship small, incremental improvements frequently
- **Version control** - All content is managed in Git with clear commit messages

Check warning on line 20 in guides/how-we-work.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/how-we-work.mdx#L20

In general, use active voice instead of passive voice ('is managed').
- **Feature branches** - New content is developed in isolation before merging

Check warning on line 21 in guides/how-we-work.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/how-we-work.mdx#L21

In general, use active voice instead of passive voice ('is developed').
- **Continuous integration** - Automated checks validate formatting and links on every commit

## Communication practices

Clear communication keeps our team aligned:

Check warning on line 26 in guides/how-we-work.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/how-we-work.mdx#L26

Try to avoid using first-person plural like 'our'.

- **Async-first** - Default to written communication for transparency and flexibility
- **Dedicated channels** - Separate channels for different topics (announcements, questions, reviews)

Check warning on line 29 in guides/how-we-work.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/how-we-work.mdx#L29

Use parentheses judiciously.
- **Decision logs** - Document important decisions and their rationale
- **Regular syncs** - Scheduled meetings for discussions that benefit from real-time conversation

## Collaboration guidelines

We work together effectively by following these principles:

Check warning on line 35 in guides/how-we-work.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/how-we-work.mdx#L35

Try to avoid using first-person plural like 'We'.

- **Ownership** - Each project has a clear owner responsible for driving it forward
- **Feedback culture** - Give and receive constructive feedback openly
- **Knowledge sharing** - Document learnings and share them with the team

Check warning on line 39 in guides/how-we-work.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/how-we-work.mdx#L39

Did you really mean 'learnings'?
- **Respect timezones** - Be mindful of colleagues in different locations when scheduling