Passo 1 Conhecimentos Gerais sobre o Manual do Usuário do Modelo
Antes de realmente usar o Manual do Usuário do Modelo e outras ferramentas que desenvolvi para Philip, eu queria ter certeza de que temos o mesmo ponto de partida. Dei-lhe algumas informações gerais sobre as instruções de utilização e alguns bons exemplos de manuais de Utilização existentes.listei esta informação abaixo.,
Qual é a definição de um manual de utilizador?um manual de Utilizador é um documento de comunicação técnica destinado a prestar assistência às pessoas sobre a utilização de um produto. Um bom manual de usuário ajuda os usuários em como usar um produto de forma segura, saudável e eficaz.,
Outros nomes, ou outras formas de um manual do usuário, pode ser:
- guia do Usuário
- documentação Técnica
- manual
- manual
- manual de Treinamento
- Guia de Início Rápido
- manual de Instalação
- manual de Manutenção
- manual do programa
Além do objetivo principal de um manual do utilizador (para ajudar o usuário), os objetivos secundários poderia ser a criação de uma melhor experiência do usuário e atender aos requisitos legais.
um manual do utilizador consiste em informação visual textual (ilustrações, imagens, tabelas, etc.,) para ajudar o usuário a completar tarefas específicas.
O usuário desempenha o papel central ao elaborar um manual de usuário. Um manual de Utilizador bem elaborado apenas fornece as informações relevantes para o utilizador pretendido do produto.o manual do utilizador deve conter informação processual (instruções passo a passo) e informação conceptual (informação de que o utilizador necessita para compreender informação processual).
um bom manual de Utilizador é conciso e usa linguagem livre de jargões. Um bom manual de usuário deve responder como e que perguntas., Eles devem conter informações sobre o que acontece se uma tarefa não é feita corretamente.em alguns casos, um produto destina-se a ser utilizado por diferentes tipos de utilizadores. Os tipos típicos de utilizadores são o utilizador final, o instalador, o engenheiro de manutenção e o operador. Cada tipo de usuário precisa de uma abordagem diferente em termos de linguagem a ser usada, o tom de voz e forneceu informações conceituais.
Que informação deve constar de um manual do utilizador?diferentes tipos de produtos precisam de um manual de utilizador. Um produto pode ser um sistema, ferramenta, dispositivo, um instrumento, um pedaço de software ou um aplicativo.,arnings
a Utilização de um manual do usuário modelo
A principal ferramenta que desenvolvi para ajudar a Philip elaborar o seu manual do usuário é um Manual do Usuário do Modelo., O modelo contém todas as informações e mais da lista acima. Cumpre os requisitos para o seu produto.
O modelo de Manual Do Utilizador pode ser usado para criar o seu manual para o seu sistema, ferramenta, dispositivo, instrumento, ou para criar um manual de instalação, manual de software, manual operacional, manual de manutenção ou manual de treino.com base no primeiro modelo para o Philip, desenvolvemos modelos para os seguintes grupos de produtos: Dispositivos Médicos Brinquedos máquinas Electrónica Electrónica quais os formatos de um manual de utilizador?,
os manuais do utilizador podem ser fornecidos em formato de papel ou como documento electrónico (PDF ou colocado online ou em dispositivo em HTML). O modelo manual de usuário é um documento MS Word que pode ser impresso ou colocado online.
manuais de usuário podem ser criados usando uma variedade de ferramentas. Cada ferramenta tem suas próprias vantagens e desvantagens., conteúdo possível
uma solução Tudo em um
Omni-plataforma de publicações
Contém predefinição manual do usuário modelos
manual do Usuário exemplos
Enquanto a elaboração de um manual do usuário com a ajuda do Manual do Usuário do Modelo, pode ser útil ter alguns bons exemplos., Através das seguintes ligações, poderá obter uma amostra do manual do utilizador para documentação:
- instruções de instalação do IKEA
- Manual do utilizador do Jura
Passo 2 identifique o(s) utilizador (es) do seu modelo do manual do utilizador
Ok, por isso agora o Philip tem algum conhecimento básico sobre os manuais do utilizador. Vamos mergulhar nos detalhes e ações.
Quando quiser escrever um manual que ajude o seu utilizador a resolver problemas, primeiro precisa de definir quem é o seu utilizador. Isso pode ser feito através da criação de um perfil de usuário, também chamado de persona.,com uma persona, você faz algumas suposições razoáveis sobre as características do seu usuário. Isto não é apenas útil para criar suas instruções de usuário, mas é um elemento essencial no início do desenvolvimento de qualquer produto! Como um engenheiro de design industrial educado, foi assim que começamos todos os nossos trabalhos de design.
ao verificar o site da ISOVOX, eu nem sequer encontrei uma descrição clara de seus usuários pretendidos. Foi por isso que pedi ao Philip para definir os seus utilizadores e responder a perguntas como:
- Quem é o utilizador do seu produto?,o produto é utilizado profissionalmente ou principalmente em privado?que outras experiências técnicas têm? O que descreve o usuário?
criei um modelo que contém as perguntas. Pedi ao Philip para preencher o modelo.
pode usar o modelo para determinar quem é o seu utilizador. Por favor, note que a segunda página também contém as respostas de Philip, para que você tenha um exemplo de como a folha pode ser usada.
acção: Use o modelo para descrever o(s) Seu (s) utilizador (es).sou um grande fã de visualizações., Por isso, se quiser dar mais um passo na definição do seu utilizador, sugiro que visualize o seu utilizador sob a forma de uma persona. Ao criar uma personalidade você está dando ao seu usuário um nome, idade, etc, para que se torne uma pessoa real que representa o seu usuário.fiz isto pelo Philip., Este é o resultado:
Ação: Criar uma visualização de seu usuário
Se você quiser saber mais sobre a definição de seu público-alvo e a criação de personas:
Passo 3 Criar Tópicos para o Seu Problemas
Iniciar com a identificação dos problemas que o usuário(s) pode encontrar durante o ciclo de vida do produto e que ele/ela quer resolver. Os problemas típicos podem incluir: instalação do produto, Utilização do produto, utilização segura do produto, manutenção do produto e eliminação do produto.,se o problema for demasiado complexo, pode dividi-lo em pedaços.pedi ao Philip para identificar os problemas e soluções que o seu utilizador possa encontrar durante o ciclo de vida do produto. Para isso, criei outro modelo para Philip. Na coluna esquerda da página do ciclo de vida, são mencionadas as fases do ciclo de vida de um produto. Estas são derivadas da norma internacional para instruções de utilizador, a IEC / IEEE 82079. Nossos modelos de manual de usuário estão em conformidade com este padrão.
na página do ciclo de vida você vê como Philip ajustou o ciclo de vida para seu próprio produto.,acção
: Use este modelo e as instruções na primeira página para identificar os problemas que o seu utilizador possa ter durante o ciclo de vida do seu produto e apresentar as suas soluções.,
Se você deseja saber mais sobre como definir o seu usuário de problemas e a criar tópicos:
- Tópico da criação baseada no
- Minimalismo
- Informações de mapeamento
- o Agrupamento
Passo 4 Definir a Estrutura do Manual do Usuário do Modelo
Philip já identificou os problemas que um usuário possa ter com o seu produto durante o seu ciclo de vida e ele tem agora o pensamento de que a solução para resolver o problema. Em outras palavras: Philip definiu os tópicos para seu manual de usuário., Cada tópico só pode ser sobre um assunto específico, tem um propósito identificável, e deve ser capaz de ficar sozinho.
um tópico deve dar a resposta a apenas uma pergunta do Usuário. Um usuário quer resolver um problema de cada vez. Quando um usuário tiver resolvido o problema, ele/ela irá resolver o próximo problema.
um tópico se tornará uma seção no manual do Usuário. Pode ser um capítulo ou um (sub)parágrafo. Assim que um usuário está procurando uma resposta para seu problema, ele vai usar a tabela de conteúdos para descobrir como navegar para essa resposta.,
pedi a Philip para estruturar os tópicos e definir o seu lugar no manual do utilizador, atribuindo um determinado tópico a um capítulo específico ou (sub)parágrafo. O resultado pode ser visto na aba ToC.
Acção: para definir a estrutura do seu manual de utilizador:
- Copie o conteúdo da página do ciclo de vida para a página ToC.
- na página Cot, substitua o nome do produto pelo seu próprio nome.
- adicione uma coluna à esquerda. Diz “secção”.se aplicável, organize logicamente as suas secções.
- Determine quais tópicos se tornarão capítulos adicionando números de capítulos., Iniciar a numeração do produto de preparação para utilização com o número 4. Acrescentaremos mais alguns capítulos no próximo passo.
- Determine quais tópicos se tornarão parágrafos adicionando os números de seção.
- Determine quais tópicos se tornarão sub-parágrafos adicionando os números de subsecção.
criou agora a tabela de conteúdos (Cot). O COT é o contorno do manual do utilizador. Mais tarde vamos adicionar mais alguns tópicos/seções, como a introdução, informações de segurança, etc. não te preocupes em acrescentar isso agora.,
Passo 5 Criar títulos significativos
cada tópico no manual do utilizador obtém o seu próprio título. Os títulos são os (sub)títulos que precedem o texto real. Eles aparecem no Cot, para que o usuário possa navegar para as informações necessárias.assim, Philip acaba de criar os (sub)títulos para seus tópicos.
porque as entradas de ToC desempenham um papel tão importante em ajudar o seu usuário a encontrar o seu caminho, e para ajudá-los a saltar o que não é importante, eles precisam de um pouco mais de atenção.
basicamente, você deve tentar e trabalhar com três níveis de títulos: primeiro, segundo e terceiro níveis de títulos.,
a posição de primeiro nível descreve toda a secção ou capítulo (por exemplo, a instalação do produto). As rubricas de segundo nível devem utilizar o estilo “como” de fraseado (por exemplo, como montar o produto e como fazer a instalação eléctrica). Uma rubrica de terceiro nível utiliza frases-tipo (por exemplo, Conteúdo da embalagem e Ferramentas a utilizar).
pedi a Philip para redirecionar suas posições e tomar nota das seguintes diretrizes gerais:
- Use a estrutura como mostrado acima para o primeiro, segundo e terceiro nível.,certifique-se de que os títulos são auto-explicativos. O título de fazer panquecas é muito mais orientado para o usuário do que usar o MagicCook5000.certifique-se de que a rubrica abrange o tópico completo. Se a secção abranger a manutenção e reparação de um produto, a manutenção da posição estaria incompleta.se possível, tente omitir os artigos no início dos cabeçalhos
acção: escreva novos cabeçalhos para as suas entradas no Cot.
O Cot da Philips com títulos significativos pode ser encontrado na página de títulos significativos. ,
Passo 6 determinar o conteúdo Legal
dependente do mercado onde o seu produto é colocado em serviço ou em serviço, e dependente do grupo de produtos a que o seu produto pertence, legislação específica se aplica ao seu produto.em geral, a legislação exige que o seu produto seja “seguro” e, por conseguinte, estabelece requisitos gerais de segurança que o seu produto deve cumprir.estes requisitos também incluem requisitos sobre o conteúdo do manual do utilizador e as instruções de segurança.,
para vender o seu produto num mercado específico, deve certificar-se de que o seu manual de utilizador cumpre estes requisitos.
estes dois artigos abaixo dir-lhe-ão como pode descobrir exactamente qual a legislação aplicável ao seu produto para o mercado europeu e dos EUA e quais são os requisitos para o seu manual de utilizador. Pro tip: quando já existe uma declaração de Conformidade disponível, você pode encontrar as diretivas aplicáveis lá.,
- Como Criar Compatível com Manuais para a UE
- Como Criar Compatível com Manuais para os EUA
Felipe, não precisa de efectuar estes passos, conforme o modelo que ele usou já continha o conteúdo jurídico, conforme exigido pelas directivas relevantes.
Para o seu produto, isso significa que as seguintes informações são necessárias para o manual do usuário do seu produto:
da UE (relevante marcação CE directivas: LVD, EMC, RoHS, WEEE, REACH):
- O manual do usuário deve ser traduzido para o idioma(s) do país onde o produto é vendido.,o manual do utilizador deve descrever a utilização pretendida do produto.o manual do utilizador deve descrever a utilização não intencional razoavelmente prevista do produto.se aplicável, deve ser mencionada a não conformidade em zonas residenciais.o tipo, o número de lote, o número de série ou outro elemento que permita a identificação do produto devem ser mencionados no produto. Se o produto for muito pequeno, pode ser colocado no manual do utilizador.
- o nome, a denominação comercial registada ou a marca registada e o endereço postal devem ser mencionados no produto., Se o produto for muito pequeno, pode ser colocado no manual do utilizador.deve efectuar-se uma análise de risco para determinar os riscos residuais relacionados com a utilização do medicamento. Devem ser fornecidas informações de segurança para informar o utilizador das medidas a tomar.devem ser incluídas informações sobre resíduos de embalagens.
além desta legislação, existe também uma norma internacional para manuais de utilizador, a IEC/IEEE 82079-1:2019. Esta norma foi harmonizada na UE., O cumprimento das normas harmonizadas constitui uma presunção de conformidade com a legislação correspondente!
o modelo do manual do Utilizador está de acordo com esta norma.
I também criou uma lista de verificação IEC 82079 que pode ser usada para verificar se o seu manual de Utilizador está em conformidade com esta norma.
para criar um manual de utilizador internacionalmente compatível, deve sempre certificar-se de que o seu manual cumpre os requisitos da UE, dos EUA e do 80279.,Acção: para determinar os requisitos legais do seu manual de utilizador:
- siga os passos 1-2 da conformidade da UE e / ou os passos 1-6 dos artigos de Conformidade dos EUA para determinar o quadro legal para as suas instruções.estude a lista de controlo IEC 82079 para garantir que o seu manual cumpre a norma 82079.
neste vídeo eu explico como você pode criar um manual que esteja de acordo com a norma 82079:
para a loja
Passo 7 Baixar e preparar o modelo do manual de usuário
Agora Philip pode iniciar a criação real do seu manual de usuário., pedi-lhe que ajustasse o índice do modelo de acordo com o seu próprio índice. Sem, evidentemente, eliminar elementos obrigatórios…
você se lembra do Passo 4 que eu pedi para começar a numeração das seções com o Capítulo 4? Uma vez que você baixar o modelo manual de usuário doc você mesmo, você vai ver que alguns capítulos padrão foram adicionados, bem como alguns apêndices.,Acção: para ajustar o modelo do manual do utilizador:
Se quiser trabalhar com o modelo livre:
- baixe o modelo do manual do utilizador livre Palavra 2013 ou 2007
- altere os títulos da secção de acordo com o seu próprio Cot. Notem! Não ajuste o índice. O índice pode ser atualizado automaticamente depois de ajustar os títulos de seção.adicione o conteúdo obrigatório conforme determinado na etapa 6 do seu manual.se aplicável, modificar as secções 1-3 e os apêndices de acordo com as suas próprias necessidades.,
Ou utilize um dos nossos pagos modelos que contêm todo o conteúdo obrigatório, como Philip fez:
- Dispositivos Médicos da UE
- Dispositivos Médicos NOS
- Maquinaria da UE
- Máquinas-NOS
- Eletrônicos da UE
- Brinquedos da UE
Passo 8 Criar o Conteúdo para o Seu Manual do Usuário Modelo
Escrever o Uso Pretendido
A finalidade do produto, ou melhor: o uso a que se destina, é o coração de um manual do usuário e constitui a base de garantir a segurança e o uso adequado do produto.,
a forma como o uso pretendido é descrito também determina a sua responsabilidade e afecta o conteúdo adicional do manual do utilizador.a maior parte da legislação exige que inclua uma descrição da utilização prevista nas instruções do utilizador.
a norma internacional para as instruções de Utilização, a IEC 82079-1, fornece a seguinte definição para a utilização prevista:
uma gama exaustiva de funções ou aplicações previstas definidas e concebidas pelo fornecedor do produto
descrevendo a utilização pretendida, determina a envolvente segura do produto., E uma vez determinado o uso pretendido, você pode se concentrar em fornecer apenas essas instruções de segurança e usuário para como usar o produto dentro do envelope dado.além disso, para o uso pretendido, muitas mais normas, diretivas e regulamentos também exigem que você inclua uma descrição do abuso razoavelmente previsível.por exemplo, a utilização abusiva razoavelmente previsível de um detergente agressivo pode ser a sua utilização num ambiente de transformação de alimentos.prestar pouca atenção à descrição de uma má utilização razoavelmente previsível afectará a responsabilidade de uma empresa.,as leis/regulamentos de responsabilidade pelo produto responsabilizam o fabricante por um produto defeituoso. Se for necessário determinar a defecabilidade de um produto, serão tidas em conta todas as circunstâncias. Isso inclui a utilização razoavelmente previsível do produto.
a descrição da utilização prevista determina quais as instruções que são dadas no resto do manual. Por exemplo, se um sistema de resfriamento é usado apenas para resfriar certos medicamentos, então apenas estes procedimentos precisam ser descritos.,quando poderia razoavelmente ser previsto que o sistema de refrigeração pode ser usado como um sistema de refrigeração de órgãos, isso deve ser descrito nas instruções. Ao fazê-lo, o Senhor, na sua qualidade de fabricante, limitará a sua responsabilidade e poderá concentrar-se apenas na descrição de como utilizar o sistema para arrefecer os medicamentos.acção: escrever a utilização pretendida e a utilização indevida razoavelmente previsível do seu produto.
Figura 1. Abuso razoavelmente previsível?,
escreva as advertências de segurança com base na análise de risco
apesar de a utilização pretendida ter sido claramente definida, isto não significa que a utilização de um produto esteja completamente isenta de quaisquer riscos.para identificar os perigos decorrentes da utilização de um produto, pode efectuar uma análise de risco. Uma análise de risco pode também ser obrigatória para determinados grupos de produtos, tais como equipamento de baixa tensão, brinquedos, máquinas e equipamento para utilização em atmosferas explosivas.foram desenvolvidas normas
, Como a norma ISO 12100, sobre a forma de realizar uma análise de risco., A norma ISO 12100 também fornece um método para a tomada de medidas de atenuação: o método em três fases. De acordo com este método, existe a seguinte hierarquia de medidas de redução de riscos: medidas de concepção inerentemente seguras, medidas de salvaguarda e medidas de protecção complementares informação para utilização, isto significa que o guia do utilizador deve alertar para quaisquer riscos residuais relacionados com a utilização do produto. Isto é feito com avisos de segurança.,a good safety warning describes the nature of a hazardous situation, the consequences of not avoid a hazardous situation and the method (s) for avoid it.
para indicar o grau de perigo que pode ser encontrado pelo Utilizador, devem ser utilizadas as palavras-sinal “Perigo”, “aviso” e “precaução”.
dê uma olhada nas seguintes mensagens de segurança:
aviso! Peças rotativas. Risco de lesões graves. Mantenham as mãos afastadas. Lockout / Tagout antes da manutenção.
então você quer avisar o usuário onde uma situação perigosa pode ser encontrada. O ANSI Z535.,6 standard descreve os seguintes locais no manual do utilizador onde isto pode ser:
- agrupados num capítulo separado.
- Na primeira parte da seção específica:
- Incorporado em um procedimento:
1. Fazer.
2. Fazer. Aviso! Isto são mensagens de segurança incorporadas. Texto geral texto geral texto geral
3. Fazer.,
- no prefácio podem ser colocadas quaisquer directivas suplementares, tais como ler todas as instruções antes da utilização ou manter estas instruções para referência futura, na introdução de um manual de utilizador.
na UE, dependendo do tipo de produto, pode ser permitido fornecer apenas as informações de segurança sob forma impressa e o resto das informações em linha.
A fim de ajudar Philip a criar e colocar uma mensagem de segurança, eu criei outro modelo.acção: realizar uma análise de risco e elaborar as suas mensagens de segurança utilizando este modelo.,
crie todos os outros conteúdos
agora pedi a Philip para criar todos os outros conteúdos, tais como os procedimentos, especificações técnicas e informações legais.
I deu as seguintes dicas:
- excluir material desnecessário para evitar sobrecarga de informação (por exemplo, promoção de vendas, repetição extensa, etc).
- certifique-se de que os termos são familiares para o Usuário, as características técnicas e os termos são bem explicados e usar os Termos consistentemente.
- descreva todos os pré-requisitos que devem ser cumpridos antes do início das instruções reais., Isto também pode estar descrevendo ferramentas especiais ou espaço para manutenção e reparação.fornecer informação conceptual quando a informação for necessária para uma compreensão e execução adequadas das tarefas.
- escreve sempre o tópico com base.
- utilize uma fonte em negrito para todos os elementos do produto.
- Use um guia de estilo para o ajudar a escrever e formatar a documentação de uma forma mais clara.
- indique quando deseja adicionar uma imagem para uma melhor compreensão mais tarde.certifique-se de que as palavras e frases não são demasiado complicadas ou demasiado sofisticadas.,
- Use frases simples / padronizadas e curtas: uma frase-um comando.
- Não coloque muita informação em uma frase.
- Use a voz activa directa e os comandos assertivos.
- Use palavras como substantivos e verbos consistentemente para evitar ambiguidade.
- para escrever melhores Instruções, use os princípios do Minimalismo na comunicação técnica e Inglês técnico simplificado.
acção: criar todos os outros conteúdos para o seu manual de utilizador.mais uma vez, para a maioria dos grupos de produtos existem modelos pagos disponíveis que podem tornar o trabalho mais fácil., Estes modelos contêm todos os textos legais, informações obrigatórias de eliminação, declarações de direitos autorais e cumprem a norma IEC 82079 sobre Instruções de utilizador.
coloque os avisos de segurança na posição certa
ao usar o modelo para elaborar as mensagens de segurança, pedi ao Philip para indicar se uma mensagem de segurança é uma directiva suplementar, ou deve ser colocada como uma mensagem de segurança agrupada, secção ou embutida.
Agora que todo o texto foi criado, as mensagens de segurança podem ser colocadas no lugar certo.,acção: colocar todas as mensagens de segurança no local certo no manual do utilizador.
Passo 9 Adicionar navegação ao seu modelo de manual de utilizador
um manual de utilizador deve dar assistência às pessoas, fornecendo informações sobre como utilizar um produto. Encontrar a informação correta que resolve o problema do Usuário deve levar o menor tempo possível.
a elaboração de rubricas significativas é uma das ferramentas que ajudam os utilizadores a encontrar informações., No entanto, existem várias outras ferramentas para ajudar o utilizador a encontrar a informação que deseja, tais como:
- tabela de conteúdos
- numeração das páginas
- Índice
pedi ao Philip para actualizar a tabela de conteúdos e adicionar numeração das páginas e um índice.acção: Adicionar ou actualizar o seu índice, numeração das páginas e índice.
Passo 10 tenha o seu Manual de utilizador revisto
Philip criou agora a versão de rascunho do seu manual de utilizador, usando o modelo de manual de utilizador. Chamamos a esta versão o design de conteúdo textual.,como Philip tem um parceiro de negócios e um desenvolvedor com conhecimento de produto técnico profundo, pedi a Philip para deixá-los rever o trabalho até agora. tanto seu parceiro de negócios quanto o desenvolvedor forneceram feedback. Philip usou este feedback para otimizar o manual do Usuário.
Action: Send the draft version of the user manual to anyone within your team who might be able to deliver feedback. Peça-lhes para combinar todos os comentários em um único documento antes de enviá-lo de volta para você. Isso estimula a discussão dos membros da sua equipe e impede o desacordo em uma fase posterior.,
Passo 11 criar as imagens
Uma vez que o manual do utilizador foi revisto e optimizado, os textos são mais ou menos definidos. Isto significa que todas as imagens podem agora ser criadas e adicionadas ao conteúdo.
A razão para esperar até que os textos estejam prontos é que a criação ou edição de imagens pode ser demorado. Como as imagens devem suportar, substituir ou aumentar o texto, você quer esperar para criá-los até que os textos sejam finais.
As imagens nos manuais do utilizador podem incluir ilustrações, fotos, imagens, tabelas, diagramas e esquemas.,
Há muitas ferramentas que podem ajudar você a criar as suas imagens, tais como:
- Snagit ou o Adobe Photoshop para edição de imagens ou fotos
- Solidworks Composer ou o Google Sketchup para a criação de desenhos de linha
- Cademeuuisque ou Microsoft Visio para diagramas e esquemas
I aconselha Felipe a não utilização de fotografias como uma alternativa barata para as ilustrações. Muitas vezes, as fotos não são tão informativas porque contêm muita informação. Além disso, as fotos podem fazer um manual de usuário parecer confuso.,por essa razão, Philip usou o Sketchup do Google para criar suas ilustrações.
acção: criar as imagens para o seu manual de utilizador.
Se você quiser saber mais sobre a criação de imagens:
- Usando texto, imagens ou de vídeo
- Criar IKEA-ish manuais
Passo 12 Verificação Final do Manual do Usuário do Modelo
Antes de começar a fazer lhe o olhar bom e traduzir o conteúdo, queremos ter a certeza de que o conteúdo está completo.para isso, pedi ao Philip para usar uma lista de verificação.,acção: l certifique-se de que o seu manual de utilizador cumpre todos os requisitos relevantes da norma CEI 82079-1:2012, utilizando esta lista de verificação.
Passo 13 Desenhe o seu modelo Manual de utilizador
um manual bem concebido contribui para uma melhor marca e experiência do utilizador.
pode ajustar o modelo de Manual Do Utilizador no MS Word adicionando um logótipo da empresa e ajustando a fonte, cores, etc., mas isso pode ter limitações.
Quando você sabe como trabalhar com Adobe Indesign, ou está disposto a aprender a trabalhar com ele, isso lhe oferecerá possibilidades de design muito maiores.,
eu criei este modelo em Indesign e pedi a Philip para ajustá-lo para corresponder a sua identidade de marca.
acção: ajustar o modelo do manual de utilizador para se adaptar à sua identidade de marca, ou transferir o modelo do manual de utilizador InDesign e ajustá-lo.
Step 14 DTP Works
DTP stands for Desktop Publishing e Wikipedia describes it as ‘the creation of documents using page layout skills on a personal computer primarily for print’.
Philip tem agora tanto o conteúdo do seu manual de utilizador (ficheiro Word) como o modelo do manual de utilizador (ficheiro InDesign)., O conteúdo precisa ser colocado no modelo de concepção InDesign. Isto é chamado de Desktop Publishing.
acção:coloque o conteúdo do seu ficheiro do Word no modelo de concepção. Se você decidiu não usar o modelo de InDesign, mas preso ao arquivo Word, então você pode saltar este passo.
Passo 15 traduzir e publicar os manuais do utilizador
dependendo do mercado em que vai vender o seu produto, poderá ter de traduzir o manual do utilizador.
algumas dicas gerais:
- procure um tradutor com experiência semelhante., Este pode ser um tradutor experiente na tradução de conteúdo técnico, com produtos similares ou com manuais de tradução de usuários.se precisar de traduzir para várias línguas, trabalhar com uma agência de tradução pode poupar-lhe muito tempo.
- Pergunte ao tradutor ou agência sobre seus procedimentos de qualidade e quem vai rever o texto após a tradução.como conhece melhor o seu produto e quem é o seu público, pode ser uma boa ideia fornecer ao tradutor ou à Agência Um glossário ou uma lista com a terminologia que pretende usar.,
- procure um tradutor que possa trabalhar directamente no seu ficheiro Word ou InDesign ou encontre uma agência que possa fazer o DTP também. Em alternativa, podes fazer isto sozinho, claro.como Philip vai vender seu produto nos EUA e na UE, ele decidiu trabalhar com uma agência.acção: encontre um tradutor ou uma agência que se adapte às suas necessidades e traduza o seu manual de utilizador.
em geral, um manual de utilizador deve estar disponível num formato facilmente acessível ao utilizador. Que pode ser impresso, ou usado online ou on-device.,
Como um usuário quer informações no momento em que ele / ela precisa e, portanto, não pensa em canais, a melhor abordagem seria fornecer as instruções omni-plataforma.
na União Europeia, para alguns grupos de produtos, é ainda limitado fornecer o manual de Utilização impresso com o produto.
No entanto, a partir de abril de 2016, as instruções de muitos grupos de produtos podem ser entregues em um formato diferente do que na impressão. No entanto, há uma excepção.as informações de segurança devem continuar a ser fornecidas em papel juntamente com o produto., Além disso, a pedido de um consumidor, deverá ser disponibilizado ao consumidor um manual de utilização de papel.Philip decidiu o seguinte:- Ele fornece um manual completo impresso com o produto, incluindo as instruções de segurança.ele criou um guia de início rápido separado para ser fornecido com o produto também.
- he placed a pdf version of the full manual online.
- ele irá criar uma seção de ajuda online em seu site com a versão HTML do manual do Usuário. Aqui ele pode adicionar vídeos também., E ao otimizar a versão HTML para os motores de busca, ele torna mais fácil para seu usuário encontrar informações para seu usuário
conclusão
é tudo o que há para isso. Foi assim que o Philip criou um manual de utilizador compatível com a ajuda do modelo de manuais do utilizador e das outras ferramentas disponíveis que eu forneci.
A melhor parte de tudo isso é que você pode obter os mesmos resultados que o Philip fez seguindo este processo passo a passo sobre como criar um manual de usuário.