Project documentation is always missing in the startups. You as an Engineering Manager need to help the team create it. And the most important document you should start with is ...
Transcript
Project documentation is always missing in the startups. You, as an engineering manager, need to help the team create it. And the most important document you should start with is glossary.
Every project uses a lot of jargon and entities with not self-explanatory names. Moreover, different teams use different names for the same entity. That creates a lot of confusion, leads to bugs, missed deadlines, and unused features.
Glossary will help to align the teams, and it will help to onboard new hires. And it's important context for AI agents. The document can be very simple.
A table with two columns, term and meaning. And maybe a screenshot to illustrate some terms. Every time you run into a new term, add it to the glossary together with its synonyms.
Once created, share it with the team. They will update it and add more terms. And there you have it, the glossary, aligning the teams and bringing ubiquitous language.
More for engineering managers:
Get more content like this.
Frameworks, hard-won lessons, and tools for engineering managers — in your inbox.