Saiba como manter seus documentos de engenharia organizados com um sistema de gerenciamento de documentos e algumas práticas recomendadas. Este artigo aborda a escolha de uma ferramenta de software, a definição de uma estrutura, a nomeação de arquivos, a revisão de documentos e o treinamento de sua equipe.

One thing I've found particularly helpful is using meaningful names without spaces. If you copy them from another program, Windows tends to cut the hyperlinks in the first place. Also, it is better to use only English symbols to avoid possible problems.

Você está lutando para manter seus documentos de engenharia organizados. Qual é a melhor maneira de começar?

Alimentado por IA e pela comunidade do LinkedIn

Se você é um gestor de engenharia, sabe o quanto é importante manter seus documentos de engenharia organizados. Os documentos de engenharia são a espinha dorsal de qualquer projeto, seja um software, hardware ou design de sistema. Eles incluem especificações, requisitos, diagramas, código, testes, relatórios e muito mais. Sem uma organização adequada, você corre o risco de perder o controle das mudanças, criar inconsistências, perder tempo e comprometer a qualidade. Mas como começar a organizar seus documentos de engenharia? Aqui estão algumas dicas para ajudá-lo.

Principais especialistas neste artigo

Selecionados pela comunidade a partir de 11 contribuições. Saiba mais

1 Escolha um sistema de gerenciamento de documentos

Ao selecionar um sistema de gerenciamento de documentos (DMS), considere suas medidas de segurança, recursos de colaboração, integrações com outras ferramentas, recursos e custo. A segurança é essencial para proteger os documentos contra acesso, modificação ou exclusão não autorizados. O DMS também deve facilitar a colaboração entre os membros da equipe, permitindo que eles trabalhem nos mesmos documentos, acompanhem alterações e comuniquem feedback. Além disso, ele deve se integrar com outras ferramentas, como editores de código e software de gerenciamento de projetos. Recursos como controle de versão, pesquisa, metadados, fluxos de trabalho e modelos também devem ser levados em consideração. Por fim, analise o custo do DMS e as limitações ou benefícios dos diferentes planos.

Adicione sua opinião

Yogesh S.

Principal ASIC Design Engineer at Infinera with 2.5+ Decades of Complex Silicon IP / ASICs / SoC Architecture & Design Experience -- Telecommunication, Networking, & Storage Domains.
Denunciar contribuição
DMS is an essential to keep the documents organised. In my view the following are important considerations to be kept in mind while choosing DMS. A. User experience (this is what user care) 1. Documents should be searchable. 2. It should be hosted in such a way that it can be accessed in a fraction of a second, to allow seamless user experience. 3. Editable docs should have collaboration capability. 4. 2-3 level of categorisation will help to find docs quickly. More levels will be detrimental to find it easily. B. Security, access control etc (this is what organisation care) 1. Secure access, access/permission control. 2. Version control, and easy & quick access of prior version are important 3. Disk space 4. Cost, one time/recurring

Traduzido

Gostei

2 Definir uma estrutura de documento

A próxima etapa é definir uma estrutura de documento que faça sentido para seu projeto e equipe. Essa estrutura organiza documentos em categorias, subcategorias e arquivos. Por exemplo, você pode ter uma pasta para cada projeto, uma subpasta para cada fase ou componente e arquivos para cada tipo de documento. Uma estrutura de documento pode facilitar a localização do que você precisa, evitar duplicação ou confusão de documentos, manter a consistência e a clareza entre documentos e seguir as práticas recomendadas e os padrões para documentação.

Adicione sua opinião

Daniel Hopfner

Project Manager for Manufacturing and Digitalization with more than 20 Product Launches and Changes // Productivity Nerd // Helping you to become a better Project Manager
Denunciar contribuição
In case you work in a production/ manufacturing environment I recommend the Value Stream of the product as general folders. Each project goes into those folders and has subfolders for the different phases it them. Once the project is done, like a optimization of the line, you take the standards created by the project and put them into the correct folders. For example: You created a new maintenance plan during the project for a new production line. Once the project is done, line is up and running, you close the project and transfer this document to the maintenance folder of the production line where every single part of the line has the maintenance documents stored.

Traduzido

Gostei

3 Implementar uma convenção de nomenclatura

A terceira etapa é implementar uma convenção de nomenclatura que siga a estrutura do documento e forneça informações úteis sobre os documentos. Uma convenção de nomenclatura é um conjunto de regras ou diretrizes para nomear seus documentos, como usar prefixos, sufixos, datas ou palavras-chave para indicar o tipo de documento, versão, status ou proprietário. Isso pode ajudá-lo a identificar e classificar documentos rapidamente, acompanhar seu histórico e progresso, evitar substituí-los ou perdê-los e cumprir os requisitos regulamentares ou contratuais para documentação.

Adicione sua opinião

Valdemārs Grimms

Senior Engineer
Denunciar contribuição
One thing I've found particularly helpful is using meaningful names without spaces. If you copy them from another program, Windows tends to cut the hyperlinks in the first place. Also, it is better to use only English symbols to avoid possible problems.

Traduzido

Gostei
Daniel Hopfner

Project Manager for Manufacturing and Digitalization with more than 20 Product Launches and Changes // Productivity Nerd // Helping you to become a better Project Manager
Denunciar contribuição
In my experience people tend to overdue it a bit here. Some of the naming conventions out there are too complex to remember. It always reminds me on the Johnny Decimal System. I understand where this is coming from, but your brain should focus on other things than remembering that convention. I try to work with maximum of 2-3 subfolders, use important keywords and the status of the document (released, ongoing, etc).

Traduzido

Gostei

4 Estabelecer um processo de revisão

O quarto passo é estabelecer um processo de revisão que garanta a qualidade e a precisão de seus documentos de engenharia. Esse processo envolve verificar, verificar e aprovar seus documentos antes que eles sejam finalizados ou entregues. Por exemplo, você pode ter revisões por pares, revisões de gerentes, revisões de clientes ou auditorias externas. Um processo de revisão pode ajudar a detectar e corrigir erros ou inconsistências em seus documentos, melhorar sua legibilidade e usabilidade, atender às expectativas e especificações de suas partes interessadas e demonstrar o valor e a credibilidade de seu trabalho de engenharia.

Adicione sua opinião

Mohamed Ziada

PMP® Project Engineer - Senior Construction Engineer | 13 Years Experience | Specializing in Large-Scale Construction Projects | Expertise in Oil & Gas | Brownfield & Greenfield
Denunciar contribuição
In the realm of document reviews, clarity is key! A solid review matrix and clearly defined document owners make all the difference. When everyone's on the same page, the review process flows smoothly. Regular check-ins and open communication keep things on track.

Traduzido

Gostei

5 Eduque e treine sua equipe

A etapa final é educar e treinar sua equipe sobre como usar o sistema de gerenciamento de documentos, a estrutura do documento, a convenção de nomenclatura e o processo de revisão. Essa etapa é essencial para garantir que todos estejam na mesma página e sigam as mesmas normas e procedimentos. Para fazer isso, crie e compartilhe uma política ou diretriz de gerenciamento de documentos que explique a lógica e as regras para organizar documentos de engenharia. Além disso, forneça exemplos e modelos de boas e más práticas de documentação, ofereça feedback e suporte aos membros da equipe à medida que eles criam e atualizam documentos e incentivam e recompensam sua equipe por aderir ao sistema de gerenciamento de documentos e melhorar suas habilidades de documentação.

Adicione sua opinião

Daniel Hopfner

Project Manager for Manufacturing and Digitalization with more than 20 Product Launches and Changes // Productivity Nerd // Helping you to become a better Project Manager
Denunciar contribuição
the system you implement should be intuative from the beginning. Nevertheless, we are all different, therefore everyone should be on the same page when it comes to the system and how to use it. In my experience, if there is too much of defense against the system from the staff, it is probably too complicated.

Traduzido

Gostei

6 Veja o que mais considerar

Este é um espaço para compartilhar exemplos, histórias ou insights que não se encaixam em nenhuma das seções anteriores. O que mais gostaria de acrescentar?

Adicione sua opinião

Timofey Samarin

Cloud Architect, Azure Leader, Engineering Manager at EPAM | Azure (8x), GCP, Linux, Python, ITIL 4, PRINCE2 Certified | 17 Years in Digital
Denunciar contribuição
From my own experience, the Microsoft 365 suite works just fine for distributed teams which produce technical documents. For instance you can collaborate in a Word document hosted on SharePoint, using its reviewing and commenting functionality. If anything goes wrong, you can restore the previous version of the document from the archive.

Traduzido

Gostei

Gestão de engenharia

+ Siga

Classificar este artigo

Criamos este artigo com a ajuda da IA. O que você achou?

É ótimo Não é muito bom

Denunciar este artigo

Ver todos

Você está lutando para manter seus documentos de engenharia organizados. Qual é a melhor maneira de começar?

1

2

3

4

5

6

1 Escolha um sistema de gerenciamento de documentos

2 Definir uma estrutura de documento

3 Implementar uma convenção de nomenclatura

4 Estabelecer um processo de revisão

5 Eduque e treine sua equipe

6 Veja o que mais considerar

Gestão de engenharia

Classificar este artigo

Agradecemos seu feedback

Outros artigos sobre Gestão de engenharia

Leitura mais relevante

Você está lutando para manter seus documentos de engenharia organizados. Qual é a melhor maneira de começar?

1

2

3

4

5

6

1 Escolha um sistema de gerenciamento de documentos

2 Definir uma estrutura de documento

3 Implementar uma convenção de nomenclatura

4 Estabelecer um processo de revisão

5 Eduque e treine sua equipe

6 Veja o que mais considerar

Gestão de engenharia

Classificar este artigo

Agradecemos seu feedback

Conhecer outras competências