Documentação - Documentation

Para obter um guia sobre como usar a documentação em modelos da Wikipedia, consulte {{ documentação }}

Documentação é qualquer material comunicável usado para descrever, explicar ou instruir sobre alguns atributos de um objeto, sistema ou procedimento, como suas peças, montagem, instalação, manutenção e uso. A documentação pode ser fornecida em papel, online ou em mídia digital ou analógica , como fitas de áudio ou CDs . Os exemplos são guias do usuário, white papers, ajuda online e guias de referência rápida. Documentação em papel ou em papel se tornou menos comum. A documentação geralmente é distribuída por meio de sites, produtos de software e outros aplicativos online.

A documentação como um conjunto de materiais instrucionais não deve ser confundida com a ciência da documentação , o estudo do registro e recuperação da informação.

Princípios para produção de documentação

Embora os padrões ISO associados não estejam facilmente disponíveis publicamente, um guia de outras fontes para este tópico pode servir ao propósito. , ,

O desenvolvimento da documentação pode envolver a redação, formatação, envio, revisão, aprovação, distribuição, reenvio e rastreamento de documentos, etc., e são convocados por SOPs associados em uma indústria regulatória. Também pode envolver a criação de conteúdo do zero. A documentação deve ser fácil de ler e compreender. Se for muito longo e prolixo, pode ser mal interpretado ou ignorado. Devem ser usadas palavras claras e concisas e as frases devem ter no máximo 15 palavras. A documentação destinada ao público em geral deve evitar termos específicos de gênero e preconceitos culturais. Em uma série de procedimentos, as etapas devem ser claramente numeradas. , , ,

Produzindo documentação

Redatores técnicos e comunicadores corporativos são profissionais cujo campo e trabalho é a documentação. O ideal é que os redatores técnicos tenham experiência no assunto e também em redação, gerenciamento de conteúdo e arquitetura de informações. Os escritores técnicos colaboram mais comumente com especialistas no assunto (PMEs), como engenheiros, especialistas técnicos, profissionais médicos, etc. para definir e, em seguida, criar documentação para atender às necessidades do usuário. As comunicações corporativas incluem outros tipos de documentação escrita, por exemplo:

  • Comunicações de mercado (MarCom): os redatores da MarCom se esforçam para transmitir a proposta de valor da empresa por meio de uma variedade de mídias impressas, eletrônicas e sociais. Esta área da redação corporativa está frequentemente envolvida em responder a propostas.
  • Comunicação técnica (TechCom): os redatores técnicos documentam o produto ou serviço de uma empresa. As publicações técnicas podem incluir guias do usuário, manuais de instalação e configuração e procedimentos de solução de problemas e reparo.
  • Redação jurídica : esse tipo de documentação geralmente é preparado por advogados ou paralegais.
  • Documentação de conformidade: Este tipo de documentação codifica os Procedimentos Operacionais Padrão (SOPs), para quaisquer necessidades de conformidade regulamentar, como para aprovação de segurança, tributação, financiamento, aprovação técnica e todos
  • Documentação de saúde: Este campo de documentação abrange o registro e validação oportuna de eventos que ocorreram durante o curso de prestação de cuidados de saúde.

Documentação em ciência da computação

Artigo principal: Documentação de software

Tipos

A seguir estão os tipos de documentação de software típicos:

A seguir estão os tipos típicos de hardware e documentação de serviço:

  • Diagramas de rede
  • Mapas de rede
  • Folha de dados para sistemas de TI (servidor, switch, por exemplo)
  • Catálogo de Serviços e Portfólio de Serviços ( ITIL )

Ferramenta de pasta de documentação de software (SDF)

Um tipo comum de documento de software escrito na indústria de simulação é o SDF. Ao desenvolver software para um simulador, que pode variar de dispositivos aviônicos incorporados a bancos de dados de terreno 3D por meio de sistemas de controle de movimento total, o engenheiro mantém um caderno detalhando o desenvolvimento "a construção" do projeto ou módulo. O documento pode ser uma página wiki, um documento do MS Word ou outro ambiente. Eles devem conter uma seção de requisitos , uma seção de interface para detalhar a interface de comunicação do software. Freqüentemente, uma seção de notas é usada para detalhar a prova de conceito e, em seguida, rastrear erros e aprimoramentos. Finalmente, uma seção de teste para documentar como o software foi testado. Isso documenta a conformidade com os requisitos do cliente. O resultado é uma descrição detalhada de como o software é projetado, como construir e instalar o software no dispositivo de destino e quaisquer defeitos conhecidos e soluções alternativas. Este documento de construção permite que futuros desenvolvedores e mantenedores se familiarizem com o software em tempo hábil e também fornece um roteiro para modificar o código ou procurar bugs.

Ferramentas de software para inventário e configuração de rede

Essas ferramentas de software podem coletar dados automaticamente de seu equipamento de rede. Os dados podem ser para inventário e para informações de configuração. A Biblioteca ITIL solicita a criação de um banco de dados como base para todas as informações do responsável de TI. É também a base para a documentação de TI. Os exemplos incluem configuração XIA.

Documentação na justiça criminal

"Documentação" é o termo preferido para o processo de preenchimento de bancos de dados criminais. Exemplos incluem o Nacional Antiterrorismo Centro 's Terrorist Identities Datamart Environment ( "TIDE"), sex offender registros e bancos de dados de gangues.

Documentação na educação infantil

A documentação, no que se refere ao campo da educação infantil, é "quando percebemos e valorizamos as idéias, pensamentos, questões e teorias das crianças sobre o mundo e, em seguida, coletamos vestígios de seu trabalho (desenhos, fotos das crianças em ação e transcrições de suas palavras) para compartilhar com uma comunidade mais ampla "

Assim, a documentação é um processo, utilizado para vincular o saber do educador e a aprendizagem da criança / crianças com as famílias, outros colaboradores e até mesmo com as próprias crianças.

A documentação é parte integrante do ciclo de investigação - observar, refletir, documentar, compartilhar e responder.

A documentação pedagógica, em termos da documentação do professor, é a "história do professor sobre o movimento na compreensão das crianças". De acordo com Stephanie Cox Suarez em 'Documentation - Transforming our Perspectives', "os professores são considerados pesquisadores, e a documentação é uma ferramenta de pesquisa para apoiar a construção do conhecimento entre crianças e adultos"

A documentação pode assumir muitos estilos diferentes na sala de aula. O seguinte exemplifica as maneiras pelas quais a documentação pode tornar a 'pesquisa', ou aprendizagem, visível:

  1. Painéis de Documentação (apresentação em quadro de avisos com múltiplas fotos e descrições sobre o projeto ou evento).
  2. Diário diário (um diário mantido todos os dias que registra a brincadeira e o aprendizado em sala de aula)
  3. Documentação desenvolvida por ou com as crianças (ao observar crianças durante a documentação, a lente da observação da criança é usada na documentação real)
  4. Portfólios individuais (documentação usada para rastrear e destacar o desenvolvimento de cada criança)
  5. Documentação eletrônica (usando aplicativos e dispositivos para compartilhar documentação com famílias e colaboradores)
  6. Transcrições ou gravações de conversas (usar a gravação na documentação pode trazer reflexões mais profundas para o educador e para a criança)
  7. Histórias de aprendizagem (uma narrativa usada para "descrever a aprendizagem e ajudar as crianças a se verem como aprendizes poderosos")
  8. A Sala de Aula como Documentação (reflexões e documentação do ambiente físico de uma sala de aula).

A documentação é certamente um processo em si, e também um processo dentro do educador. A seguir está o desenvolvimento da documentação à medida que avança para e no próprio educador:

  • Desenvolver hábitos de documentação
  • Fique à vontade para ir a público com a recontagem de atividades
  • Desenvolver habilidades de alfabetização visual
  • Conceitualizar o (s) propósito (s) da documentação como tornar os estilos de aprendizagem visíveis, e
  • Compartilhe (s) teorias visíveis para fins de interpretação e posterior design do currículo.

Veja também


Referências

links externos