Blog dos voluntários do Texto Livre

www.textolivre.org

A importância da documentação em software para usuários iniciantes

with 77 comments

Documentar é importante! Isso é um fato “consumado”. Alguns levam a documentação muito a sério e outros documentam por obrigatoriedade. O software livre é uma produção colaborativa de divulgação ampla, documentar esse processo é fundamental, assim como divulgar os resultados, para que o princípio de compartilhar conhecimento seja cumprido. O software livre busca ampliar o número de usuários que não sejam especialistas em computação. O usuário iniciante em programação, para a compreensão de um software, necessita entender os comandos necessários para o seu funcionamento. A documentação em software auxilia o iniciante a utilizar e manipular essas informações. A documentação faz com que o usuário tenha uma noção de onde buscar “ajuda”, tornando-o mais independente na sua missão de mergulhar em um “mundo desconhecido”. Podemos dizer que o software livre é uma “ilha paradisíaca”, totalmente inexplorada e a documentação é o mapa que guia o usuário iniciante para as suas primeiras “explorações”. No entanto, serão necessárias muitas “viagens” a “ilha” para que o usuário iniciante possa aprender o caminho e retornar sempre que achar necessário. Todavia, nesse percurso o usuário necessita de algumas orientações de como utilizar essa documentação e realizar a interpretação mais adequada. Sem o “mapa” da rota a ser seguida, ou seja, a documentação, o usuário iniciante torna-se totalmente dependente de outros auxílios, por exemplo, “guias de exploração da ilha” – profissionais da programação. Não que os “guias” não sejam necessários, mas sem a documentação em software, eles se tornam indispensáveis e o usuário torna-se sempre dependente desse auxílio. Desse modo, a documentação em software auxilia o usuário iniciante em programação, tornando-o mais independente de outros auxílios. Sem a documentação em software é impossível “viajar” sozinho.

Texto de Ludimila Nascimento para o VI Evidosol/III Ciltec-online.

Anúncios

Written by otextolivre

2 junho 2010 às 12:51 pm

77 Respostas

Subscribe to comments with RSS.

  1. Ótimo texto, destaca bem a necessidade de documentar quando se trata de software livre. Pode-se dizer que a comunidade só se forma quando a documentacão é bem acessível, coisa rara às vezes.

    Yaso

    7 junho 2010 at 6:42 pm

    • Ótimos texto, visto que estou entrando no “mundo” dos softwares livres agora e um documento para guiar-me será de grande valia. O medo do desconhecido ronda todos nós, mas quando temos um suporte esse medo se converte em curiosidade impulsionando-nos a conhecer e buscar mais informações sobre esse desconhecido.

      Luana Thamiris

      14 setembro 2010 at 12:45 am

  2. Pessoal, boa noite!
    Temos uma empresa especializada em elaboração de documentação técnica, inclusive de Sfotwares com mais de 10 anos de experiência.

    Essa matéria foi muito interessante e vêm de encontro com nossa proposta…

    Para conhecer mais, acessem: http://www.solutiondoctec.com.br.

    Abraços,

    Eng. Hugo

    Hugo Araújo

    28 julho 2010 at 10:46 pm

  3. Me identifiquei com o texto, pois sou uma iniciante em software livre e a documentação sobre este assunto tem me auxiliado bastante na descoberta desse “mundo livre”. Concordo plenamente com a importância da documentação, não só para os novos usuários, como também para os mais experientes.

    Marianna KL

    30 agosto 2010 at 9:43 pm

  4. A documentação clara e acessível é importante para apoiar a difusão do software livre. Auxiliar os novos usuários a serem independentes, a caminharem com as próprias pernas nesse mundo novo, fará com que as experiências com software livre sejam mais satisfatórias.

    André Alves

    2 setembro 2010 at 12:52 am

  5. Para quem está iniciando no assunto, o texto livre, certamente, é uma ferramenta essencial de aprendizado. O que seria do ensino sem o livro texto e o que seria do conhecimento em software livre sem os textos livres.

    Camila

    2 setembro 2010 at 8:00 pm

  6. Olá,

    gostei muito do texto e concordo com ele. Nosso mundo tem muita informação nova e se não soubermos como utilizá-la, não dá para aproveitar. Depender dos “guias” mencionados no texto desanima o usuário de prosseguir a “viagem”. Por isso a documentação se torna importante. Não só para software livre, mas para tudo.

    Luisa

    Luisa Peixoto

    2 setembro 2010 at 8:09 pm

  7. Documentação é importante, mas não é nada simples. É preciso ter muito cuidado de forma a escrever com clareza para que não haja dúvidas para usuários iniciantes. Por isso é bom sempre ter cuidado de se colocar no lugar de uma pessoa diferente que lê o seu texto ao escrevê-lo.

    Fábio Kunoh

    2 setembro 2010 at 8:23 pm

  8. Concordo plenamente com a questao do documentar, e hoje em dia muitas pessoas acabam fazendo isso sem dar muita importancia por ser algo somente obrigatorio, eu mesmo ja passei por isso

    Renato

    3 setembro 2010 at 11:25 am

  9. Acho importante documentar a produção existente no software livre, mas isso não se extende só aos usuários iniciantes. A documentação é necessária para todos os que usam ou desejam usar o software livre. Primeiro porque é necessário organizar tudo aquilo que foi gerado e em segundo porque, para manter este iniciativa ativa, toda a produção colaborativa deve estar acessível a todos os usuários, independentes de serem iniciantes ou não. A documentação também traz outro benefício: os usuários podem interpretar e reinterpretar as informações, contribuindo com o aprimoramento das mesmas, facilitando ainda mais o acesso de um usuário inciante.

    Glauber Resende de Paula

    4 setembro 2010 at 6:54 pm

  10. A documentação é realmente muito importante para auxiliar o usuário na utilização de programas como o software livre, já que são novos e poucos sabem como proceder diante esses programas. É assim que se consegue formar uma comunidade. Contudo é importante que essa documentação seja escrita de maneira clara e objetiva para que qualquer pessoa, inclusive aquelas totalmente leigas no assunto, possam compreender

    Rafaela Soares

    6 setembro 2010 at 2:25 pm

  11. Achei muito importante o destaque dado ao sentido colaborativo existente por trás do software livre. Isso faz com que a documentação tenha uma importância maior ainda. Nesse sentido, a documentação permitirá que as informações sejam devidamente compartilhadas e tragam importantes esclarecimentos àqueles que estão iniciando.

    Michelle

    6 setembro 2010 at 5:54 pm

  12. Quando se programa para qualquer fim a documentação é essencial, independente para qual tipo de usuário você esta programando você precisa documentar. Ao fazer um programa o raciocínio que você emprega no mesmo é único e por isso deve ser explicado em uma documentação pois até os programadores mais experientes poderiam levar dias para descobrir como você resolveu certos problemas dentro do programa. Agora para ajudar ainda mais os programadores iniciantes, alem de fazer a documentação, é interessante produzir um pequeno manual em formato receita de bolo, explicando passo a passo como operar o programa em suas funções mais comuns.

    Toffalini

    7 setembro 2010 at 1:22 pm

  13. Como estou me iniciando nesse mundo dos programas do estilo de software livre, concordo plenamente com essa extrema necessidade de documentação.
    O software livre representa uma “chuva” de informações e os iniciantes certamente não conseguem acompanhar sem um guia prático. Uma vez documentado, mais adeptos irão se adequar e dominar a utlização dos softwares livres se tornando populares para a divulgação da educação.

    Camillo Rinaldi

    7 setembro 2010 at 3:23 pm

  14. Texto muito bem escrito,fazendo analogia do software livre a uma ilha e da documentação a um mapa. Retrata a importância da documentação em software para auxiliar os usuários, principalmente os iniciantes em programação.

    Fabiane

    9 setembro 2010 at 11:24 pm

  15. Ludmila,

    Você está coberta de razão,pois não seríamos ninguém
    nesse mundo novo, sem um guia.

    Raquel

    10 setembro 2010 at 4:01 pm

    • O texto é muito interessante,porque mostra o quanto os softwares livres são importantes para os usuários.Ainda mesmo porque é gratuito e é um modo de inclusão social.

      Angelina Dayanne

      13 setembro 2010 at 2:09 pm

  16. Ludmila, em primeiro lugar parabéns pelo texto. A questão de documentar é importante para a aquisição de conhecimentos em qualquer área. E como a idéia do software livre é reunir pessoas e estimulá-las a trocar conhecimentos de uma nova forma, documentar é ainda mais importante. Gostaria de destacar que informar é preciso, mas devemos ter cuidado com a linguagem, levando em consideração as possíveis barreiras linguísticas que possam vir a se colocar no caminho dos usuários.

    Lucere Mendes

    10 setembro 2010 at 6:53 pm

  17. ótimo texto, retrata bem como se deve proceder para a documentação em software.

    byakuya2010

    10 setembro 2010 at 10:37 pm

  18. Documentação é sempre fundamental. Em Software Livre possui ainda um diferencial: a possibilidade de captar novos colaboradores, além da concepção não discriminatória da visão de comunidade de Software Livre.

    Entretanto, uma discussão que veio à tona e ainda não se conseguiu delimitar todas as arestas é a questão da padronização dessa documentação. Principalmente por esse conceito de colaboração, diferentes usuários contribuem a cada momento com suas documentações. Portanto, é fundamental que se consiga modelar um padrão para normalizar essas documentações que serão usadas em conjunto.

    Marcela

    10 setembro 2010 at 11:11 pm

  19. Com certeza a documentação, como já dito anteriormente, é essencial, para dar direção àqueles que são iniciantes neste vasto mundo a ser explorado que é o software livre. É um guia confiável e sólido, que possibilita se adquirir os vários e novos conhecimentos na área. Mas para que se possa produzir textos e documentar todo o necessário para introduzir o iniciante nessa área, sem deixá-lo totalmente perdido e desorientado, é indispensável que aquele que produz a documentação tenha capacitação e experiencia.

    Gabrielle V. Ruas

    11 setembro 2010 at 12:10 am

  20. Certamente, a documentação de um software é importante. Já passei por situações de pegar o código-fonte de programas não documentados e perder semanas para entender o que se passava. Em outras situações, com códigos bem documentados, compreendia o conteúdo em alguns minutos.
    A importância dessa tarefa é vista nessas situações.
    Vale lembrar que softwares não documentados afastam usuários inexperientes.

    Guilherme GP

    11 setembro 2010 at 4:59 pm

  21. Concordo plenamente com o texto!
    O Software Livre tem a intenção de compartilhar
    textos e demais programas entre as pessoas.
    Mas sem a documentação, esse número de pessoas
    é restrito já que nem todo mundo consegue acessar
    com facilidade. Sendo assim, o objetivo do softaware é ”modificado” já que ele não é livre mais para todo mundo. A documentação permite que pessoas que tem dificuldade e até mesmo não conseguem de forma alguma, possam obter independência para manipular os programas sem a ajuda de ninguém. Sem contar que é interessante inserir todas as pessoas nesse meio, o que não seria possível sem a documentação em que elas podem se guiar.

    Luiza

    11 setembro 2010 at 7:29 pm

  22. O seu texto é bastante interessante e não discordo da importância que tem a documentação de software para usuários iniciantes — e de outros níveis também. No entanto, no mundo do software livre, outras preocupações também deveriam ser levadas em conta.

    Um bom manual não ajuda o usuário quando o software realmente é ruim ou quando bugs fazem com que as instruções contidas nele se tornem inválidas. Há também o problema de o usuário típico não estar disposto a ler documentos para aprender a utilizar um software — atire a primeira pedra aquele que sempre lê a documentação dos softwares que utiliza.

    Sendo assim, de acordo com a minha percepção de desenvolvedor de software, o processo de produção de software livre precisa colocar em foco o usuário que irá utilizá-lo. Premissas de usabilidade e comunicabilidade devem ser colocadas em prática. Não basta que o desenvolvimento colaborativo faça a sua parte. É fundamental e necessário ter gente na equipe preocupada com o bem estar do usuário, trabalhando para que o processo de aprendizado deste seja o mais natural e intuitivo possível.

    Hugo Alves Richard

    11 setembro 2010 at 11:59 pm

    • Está aí o meu problema com os softwares livres. Sou super a favor desse tipo de iniativa, mas muitas vezes não consigo entender o que diabos que os manuais querem dizer. As pessoas nos fóruns geralmente não ajudam. Parecem que pensam: se me virei sozinho, porque essa pessoa também não consegue fazer o mesmo. E não tenho problema em entender como que o software livre funciona, o que não costuma acontecer quando acabo comprando o programa para conseguir usar. E a razão que vejo para essa diferença é justamente a que você apontou: já que tem dinheiro envolvido, sempre vai ter alguém que vai tentar fazer o programa ser o mais intuitivo possivel para o não-iniciado.

      Raquel Dias

      13 setembro 2010 at 11:24 pm

  23. O texto é muito bom. Acredito que é muito importante destacar a importância da documentação nos primeiros passos de um usuário em contato com o software livre. Além do mais, o software livre tende a se tornar uma das principais formas de compartilhar conhecimento. Devido aos benefícios proporcionados por ele, todas os esforços para divulgá-lo e torná-lo acessível para novos usuários são muito bem vindos.

    Thiara Francis

    12 setembro 2010 at 12:15 am

  24. É verdade que muitos usuários têm facilidade em aprender a usar softwares que não conhecia. Mas a documentação é sempre de grande ajuda, ainda mais quando se mira usuários de todos os níveis.

    André Domingues

    12 setembro 2010 at 12:52 am

  25. Ótimo texto.
    Como profissional da área de computação me identifiquei com a necessidade de fazer uma boa documentação para os softwares produzidos, principalmente os de software livre. Pois assim fica bem melhor para outro usuário ou profissional entender o código e implementar novas melhorias.
    Porém, muitos pecam nesse processo, deixando a jornada bem mais complicada, é de suma importância disseminar essa prática para um melhor trabalho colaborativo!

    Vinícius Pereira de Almeida

    12 setembro 2010 at 1:30 pm

  26. Concordo totalmente com seu texto, creio que ser independente na utilização de um software livre é essencial, se a documentação é completa o bastante podemos assim nos guiarmos bem pelo software sem nos sentirmos prejudicados, achando que não sabemos nada e que precisamos da ajuda dos outros.

    Isa Paula Barbosa da Penha

    12 setembro 2010 at 2:09 pm

  27. Excelente texto.
    É necessário ter a documentação, para ajudar a melhor compreender o software e,principalmente os iniciantes em programação. É de suma importância para compreendermos linguagem e, implementar novas melhorias.

    Laís Araújo Lopes de Souza

    12 setembro 2010 at 6:36 pm

  28. O texto é muito bom. Estou começando agora a me familiarizar com Software Livre por isso acho relevante as informações contidas nesse texto. A documentação é realmente muito importante para nos ajudar a enteder melhor como utilizar os prgramas.

    Carolina Tomich

    12 setembro 2010 at 7:50 pm

  29. Excelentes reflexões. A documentação é a base do compartilhamento da informação. Sem ela, não há disseminação de informação e o software livre perde o seu objetivo mais essencial, que é atingir o maior número de usuários.

    Nathalia

    12 setembro 2010 at 8:00 pm

  30. Ótimo texto, com certeza a documentação dos software livres ajudam e muito em nossa orientação , pois sabendo bem como funciona o software e tendo documentos com informação para nos auxiliar quando preciso, faz com que se faça um bom uso do software e obtenha o máximo de seu desempenho com muita satisfação .

    lordeclesios

    12 setembro 2010 at 10:08 pm

  31. Em disciplinas de programação na faculdade, sempre havia os alunos, incusive eu mesmo, que protestavam quanto à documentação dos códigos fonte. “O importante é funcionar!”, e etc. Mas, de fato, não é bem assim. Quando pretende-se que o software seja utilizado por outras pessoas, a documentção é mesmo muito importante. A analogia com a “ilha paradisíaca” é muito boa. Também poderia ser visto como o aprendizado de um novo idioma. É preciso ter um ponto de partida para se compreendê-lo. Isso é poporcionado por uma boa documentação.

    Yuri Cravo

    12 setembro 2010 at 10:15 pm

  32. Eu, como “usuária iniciante”, se é que posso me chamar assim, acredito na importância da documentação em software.
    É sempre necessário a leigos certas ferramentas que permitam a compreensão e que, dessa forma, possibilite a utilização de um novo software.
    O mesmo acontece para os usuários experientes, que, às vezes, também precisam recorrer a alguma ajuda.

    Júlia Lopes

    12 setembro 2010 at 11:35 pm

  33. A documentação realmente é muito importante para auxiliar os usuários iniciantes de programação a terem maior facilidade em lidar com tal software.
    Pois para um programador pegar um código sem nenhum comentário e documentação ele teria uma dificuldade muito grande em entendê-lo.

    Bernardo Carlos

    12 setembro 2010 at 11:46 pm

  34. Ótimo texto, eu concordo plenamente com a importância da documentação em software, sou “usuária iniciante” e tenho muita dificuldade. A documentação ajuda MUITO pois vira um “norte” para nós.

    Ana Maria B. Feitosa

    12 setembro 2010 at 11:47 pm

  35. Justamente por ser uma iniciante em software livre, achei o texto muito útil e informativo para quem quer entrar de vez nesse “mundo”. Vejo agora que a documentação em software é fundamental para que o usuário utilize e manipule as informações com mais independência, sabendo como recorrer quando precisa de ajuda. Parabéns pelo texto!

    Luisa Sa Vitorino

    13 setembro 2010 at 12:02 am

  36. Importantíssimo o tema abordado pelo post. Precisamos tomar consciência sobre a questão da documentação em software, afim de terminar com um dependência relativa à programadores. Para iniciantes é quase uma lei de sobreviv~encia recorrer à esses profissionais, daí a importaância de haver materias que diminuam essa dependência. Vamos divulgar essa ideia!

    Adriana de Oliveira Mariano

    13 setembro 2010 at 1:37 am

  37. Acredito que no caso do software livre é fundamental a existência de uma documentação. Já que sem ela seria extremamente difícil de se trabalhar tanto com o programa quanto acrescentar algo ao código dele. A falta de uma documentação leva inclusive a discriminação do software livre, muitas pessoas deixam de utiliza-los por não um suporte e como o texto diz a documentação serve como um manual para ele.

    João Lucas

    13 setembro 2010 at 1:39 am

  38. De fato, a documentação do código fonte é fundamental. Porém, o colaborador não deve adicionar comentários por pura obrigação. É preciso observar se o comentário está claro, se ajuda, de fato, a entender o código, se todas as partes importantes estão devidamente comentadas, se o padrão de documentação está sendo seguido. Algumas vezes, um comentário mal escrito pode até confundir quem está tentando entender o trecho de código.
    A documentação deve ser criada de forma natural por todos os programadores.

    Raphaella Carvalho

    13 setembro 2010 at 11:49 am

  39. Ótimo texto.
    Concordo com esta visão sobre a documentação do software livre, pois ela é a base da informação compartilhada e de qualidade. A documentação é relevante por facilitar o manuseio do software.

    Reinaldo Candido da Costa

    13 setembro 2010 at 1:00 pm

  40. Concordo com a importância da documentação. Com uma boa documentação pode facilitar, e muito, a vida do usuário, principalmente quando esse é leigo no uso do software em questão. Outro ponto é que com a documentação, o programa pode ser mais aproveitado em relação às suas funcionalidades.
    Não somente para o usuário, a documentação também é útil para desenvolvedores, pois um código bem documentado pode facilitar o desenvolvimento de um mesmo programa por várias pessoas diferentes, assim, a prática da documentação deve ser de rotina para qualquer programador.

    Luis Filipe Matoso

    13 setembro 2010 at 5:00 pm

  41. oncordo com a importância o artigo. Com uma boa documentação pode facilitar, e muito, a vida do usuário, principalmente quando esse é leigo no uso do software em questão. Outro ponto é que com a documentação, o programa pode ser mais aproveitado em relação às suas funcionalidades.
    Não somente para o usuário, a documentação também é útil para desenvolvedores, pois um código bem documentado pode facilitar o desenvolvimento de um mesmo programa por várias pessoas diferentes, assim, a prática da documentação deve ser de rotina para qualquer programador.

    Luis Filipe Matoso

    13 setembro 2010 at 5:02 pm

  42. Concordo com o artigo. Uma boa documentação pode facilitar, e muito, a vida do usuário, principalmente quando esse é leigo no uso do software em questão. Outro ponto é que com a documentação, o programa pode ser mais aproveitado em relação às suas funcionalidades.
    Não somente para o usuário, a documentação também é útil para desenvolvedores, pois um código bem documentado pode facilitar o desenvolvimento de um mesmo programa por várias pessoas diferentes, assim, a prática da documentação deve ser de rotina para qualquer programador.

    Luis Filipe Matoso

    13 setembro 2010 at 5:02 pm

  43. A documentação é uma ótima ideia para os leigos no assunto,pois dessa forma eles tem onde encontrar ajuda.Através da documentação o usuário conhece novas ferramentas e se interessa pelo assunto,buscando sempre novas informações sem precisar ter o auxílio de uma pessoa ao lado.Pois,muita das vezes os usuários se sentem constrangidos de pedir ajuda até mesmo para amigos e com a documentação ele mesmo pode solucionar suas dúvidas.

    Natália Rodrigues Rocha

    13 setembro 2010 at 6:28 pm

  44. Pelo que pude ler em todos os comentários deste post, é um consenso a opinião sobre a documentação de softwares livres. Eu penso da mesma forma: tutoriais bem escritos aproximam os novos usuários a testarem novos programas e, pelo fato de encontrarem textos mais claros, obtêm maior êxito. Consequentemente, aumenta-se ainda mais o interesse em outros softwares, e assim por diante.
    Assim como um prato precisa de uma receita culinária para ser feito, um remédio precisa de uma bula e um software de um documento correspondente.

    Felipe Cristelli

    13 setembro 2010 at 6:33 pm

  45. Eu concordo com este artigo. A documentação é praticamente um manual de intruções para aqueles que são iniciantes no assunto e na criação do software livre. Pode se dizer que a documentação é realmente algo indispensável para novatos, e sem ele, seria algo muito difícil, talvez mesmo impossível como a Ludimila disse.

    Lucas Alves

    13 setembro 2010 at 7:32 pm

  46. A documentação é impressindivel para que pessoas com total desconhecimento do assunto possam se interar e aprofundar sobre o tema.Além disso permite aquelas pessoas que por algum motivo tem receio de pedir a ajuda de alguem possam ter mais interesse sobre o tema de uma maneira independente e facil.

    Lucas Provenzano

    13 setembro 2010 at 7:47 pm

  47. Vale reforçar que a qualidade da documentação de um software é um fator importante: de nada adianta a existência de um guia se este não é de fácil entendimento. As pessoas se interessam pelo aprendizado do software livre a fim de ganhar a liberdade que ele oferece, porém ainda existe uma facilidade de acesso aos outros softwares que já são, de praxe, muito facilmente manuseados. A qualidade do texto, então, seria um parâmetro capaz de quebrar a comodidade do usuário, fazendo-o migrar para o uso de softwares livres e contribuir para o seu crescimento.

    Telma Eugênio

    13 setembro 2010 at 7:58 pm

  48. Ótimo texto. Concordo plenamente com a importância da documentação em software para usuários iniciantes, pois documentando um software nos auxilia a deixa-lo mais atrativo e melhor organizado.

    Raphael Evandro

    13 setembro 2010 at 8:42 pm

  49. A documentação de softwares tem um papel fundamental de orientação aos seus usuários, uma vez que algumas informações para uso, como instalação, nem sempre são as mesmas para todos os softwares. Estes softwares, mesmo sendo de qualidade, precisam de um conjunto de vários tipos de documentação necessários para dar suporte ao usuário, incentivando e facilitando a utilização do software propriamente dito. Tal suporte, é claro, torna-se ainda mais importante no caso de usuários iniciantes.

    Filipe Santana de Freitas

    13 setembro 2010 at 8:44 pm

  50. Realmente, a documentação é muito importante. Muitas vezes, fui salvo por documentações de softwares, quando estava totalmente perdido. E vale lembrar, que uma boa documentação é essencial, caso contrário, tempo é perdido com informação confusa ou errada.
    Ainda não tive oportunidade de criar documentações, mas pretendo escrever algumas sobre determinados assuntos no futuro.

    André Santos

    13 setembro 2010 at 9:10 pm

  51. A preocupação em se formatar uma documentação relacionada ao Software livre para iniciantes mostra-se extremamente válida, pois a partir daí, o conhecimento passará a existir de forma sólida e consistente para todos que o desejarem possuir.

    Leticia Apgáua

    13 setembro 2010 at 9:32 pm

  52. Uma boa documentação é de fundamental importância para qualquer tipo de usuário ( iniciante ou não ) pois proporciona um melhor e mais rápido entendimento do código que será utilizado.

    Felipe D. Almeida

    13 setembro 2010 at 10:00 pm

  53. A documentação representa o cartão de visitas de uma ferramenta hoje em dia. Tendo em vista o grande número de alternativas de qualidade hoje em dia, o usuário final tende a preferir aquela que é melhor documentada, aquele que ele sabe que caso encontre alguma dificuldade terá um respaldo de fácil acesso e bem estruturado.

    Do outro lado, o desenvolvedor, interessado no sucesso de seu software, deve garantir que aqueles que utilizem sua ferramenta sejam incentivados a continuar usando. Além disso, o usuário que possui maior conhecimento, de fácil acesso em suas mãos, tem maior chance de dar um feedback positivo pro desenvolvedor, garantindo um ciclo onde o desenvolvedor está sempre fornecendo uma ferramenta cada vez melhor para um usuário cada vez mais satisfeito.

    Assim, a documentação é de fato fundamental para iniciantes em uma nova plataforma ou ferramenta.

    Artur Rodrigues

    13 setembro 2010 at 10:57 pm

  54. Concordo com seu texto, a documentação é indispensável para a migração em direção um novo sistema ou software ou seja la a ferramenta que for, sem uma orientação coerente, direta e simples, a compreensão e o uso acabam ficando restritos, e na cultura livre a ideia é atingir todas as massas.

    brenoufmg

    13 setembro 2010 at 11:24 pm

  55. Sou iniciante nessa questão de software livre e realmente percebo que a informação sobre esse assunto ainda é pouca em vista do seu tamanho. Muitos como eu se perdem na hora de utilizar o programa e quando procuram por ajuda tem dificuldades em encontrar. A documentação realmente é muito importante para nos auxiliar, guiar nesse novo mundo de software.

    Juliana Mendes de Araujo Alves

    13 setembro 2010 at 11:44 pm

  56. Bom post. Tema importante. Comecei a trabalhar recentemente em uma área que possui tanto muitas opções de software proprietário, como de software livre.
    Não é só a limitação técnica que pode levar uma pessoa(ou uma empresa) a adotar soluções proprietárias. No nosso caso específico, encontrar aplicações bem documentadas têm tido bastante peso.
    Como o post conclui, sem a documentação é inviável “viajar” sozinho, que é uma contradição para um software livre. Já que um de seus intuitos é permitir a seus usuários viajarem com as próprias pernas.

    Henrique Dias

    13 setembro 2010 at 11:57 pm

  57. A documentação em software livre é muito importante tanto para a divulgação de projetos, como a manutenção e configuração de sistemas.Para usuários em geral , a qualidade da documentação é um dos fatores que incentiva a utilização e a continuidade de projetos open source, portanto deve ser levada a serio por todos que querem contribuir de uma forma efetiva para a comunidade de código livre.

    Elerson Santos

    14 setembro 2010 at 12:06 am

    • Criar softwares livres sem documentação basicamente limita o uso apropriado deste software a usuários já familiarizados e especializados neste tipo de assunto, praticamente excluindo novos usuários deles, uma vez que sem instrução se torna muito difícil interagir com os mesmos. Tal fato vai contra o principio básico do próprio software livre, que é algo feito para todos usufruírem.
      Além disso, um software bem documentado facilita muito o aprendizado de iniciantes e, por conseqüência, o induz a procurar mais softwares e indicar a amigos a fazer o mesmo, ou seja, a boa documentação do software não só atua como um marketing positivo dele mais também dos softwares livres de um modo geral.

      Breno Lara

      14 setembro 2010 at 12:36 am

  58. A documentação em software para principiantes é essencial para o crescimento do usuário dentro do universo do Software livre, sem ela suas ações ficam muito limitadas e a ideologia de compartilhamento do software livre se perde.

    carantes

    14 setembro 2010 at 1:04 am

  59. Achei o texto muito interessante.
    Um software bem feito ajuda o aprendizado de iniciantes e é muito interessante que eles se interessem pelo assunto e possam interagir nesse novo meio,gerando aprendizagem nessa nova era.

    Victória Goncalves

    14 setembro 2010 at 1:24 am

  60. A documentação de software é muito importante para as pessoas que estão iniciando, mas aquelas que são mais experientes, uma boa documentação também se faz necessária já que facilita muito o entendimento do raciocínio empregado na elaboração do programa.

    Felipe

    14 setembro 2010 at 1:25 am

  61. Olá,

    gostei muito de sua descrição sobre a importância da documentação. Digo por experiência própria que um software desenvolvidos por terceiros pode passar de impossível de ser entendido para relativamente fácil de ser entendido, desde que seja bem documentado.
    =D

    Gedeon Santos de Medeiros

    14 setembro 2010 at 1:34 am

  62. Acredito que uma boa documentação de um software seja um dos principais fatores que contribuem para o crescimento desse software. Sem uma boa documentação os usuários se sentem sozinhos no descobrimento do funcionamento do programa. Outra coisa muito importante, na minha opinião, é disponibilizar a documentação do software em diversos idiomas para que o usuário possa ler essa documentação no seu idioma nativo. A tradução de documentação é também muito importante para o crescimento de um software livre.

    Douglas do Couto Teixeira

    14 setembro 2010 at 1:46 am

  63. Olá,
    Concordo plenamente!
    Hoje, os softwares livres são muito mais utilizado por usuários experientes. Como o Software Livre tem o objetivo de atingir um maior número de usuários, faz-se necessário derrubar todas as barreiras que impedem um usuário iniciante de se utilizar softwares livres. Portanto, a documentação derruba uma grande barreira e traz mais autonomia e confiança para o usuário iniciante.

    Alisson Oliveira

    14 setembro 2010 at 1:47 am

  64. Ainda sou um “turista” nessa área de software livre e sei como é importante a ajuda da documentação para mim. Espero apreender ainda mais sobre esse universo e poder também colaborar com a sua divulgação e uso.

    Vítor Bracarense

    14 setembro 2010 at 1:49 am

  65. O texto ajudou a entender um pouquinho melhor esse “novo mundo” de textos livres.Entendo que um dos principais objetivos é o de contribuir com o aprendizado e de auxiliar as pessoas que ainda não conhecem totalmente esse meio de “troca de informações”.

    Jaqueline

    14 setembro 2010 at 1:54 am

  66. Acredito que a documentação em software livre é de fundamental importância para os iniciantes, pois facilita o aprendizado do software em questão. Sem uma documentação de qualidade, muitas vezes, o usuário perde a vontade de aprender a utilizar aquele software. Por isso acredito que uma boa documentação e tão importante quanto a qualidade do próprio software.

    Rafael P. Bonutti

    14 setembro 2010 at 1:56 am

  67. Muito bom o texto! Realmente é importante para usuários iniciantes ter esse tipo de documento ao seu alcance. Não vale de nada um software ser livre se ele não vai poder ser utilizado pela maioria das pessoas, afinal a cultura livre deve ser, acima de tudo, democrática. Outro ponto importante é a documentação e comentários sobre o código do software. Programadores também precisam de um “mapa” para o código-fonte para poderem exercer uma das liberdades do software livre: modificar o programa.

    Abraços.

    João Paulo Barros Cotta Pesce

    14 setembro 2010 at 2:25 am

  68. Software sem documentação é uma ferramenta sem manual, ainda que possamos utilizá-la não poderemos explorar todos os seus recursos. Além disso quando o desenvolvimento do software não é bem documentado torna mais difícil a colaboração, impede que voluntários possam continuar desenvolvendo. O software livre tem por característica a produção de conhecimento de maneira cooperativa e a documentação do software é um canal de comunicação entre os desenvolvedores dispostos a cooperar, se não a documentação não é bem feita fica mais difícil o diálogo.

    Luiz Henrique Maia Cruz

    14 setembro 2010 at 2:43 am

  69. Pra mim a documentação é super importante, pois sou iniciante e sinto falta de algo para orientar meu aprendizado. Por isso a documentação e tão importante quanto o desempenho do próprio software.

    Maria Cláudia Bonutti

    14 setembro 2010 at 3:04 am

  70. O texto é muito bom.É muito importante destacar a importância da documentação nos primeiros passos de um usuário em contato com o software livre, pois facilita o aprendizado do software em questão. Sem uma documentação de qualidade, muitas vezes, o usuário perde a vontade de aprender a utilizar o programa por isso acredito que uma boa documentação e tão importante quanto a qualidade do próprio software.

    tiago

    14 setembro 2010 at 11:19 am

  71. O texto trata de um assunto que deveria receber mais atenção. Todo mundo já deve ter tentado usar algum software livre e ter encontrado problemas por falta de uma documentação adequada. Um outro problema com que nos deparamos é o modo como a documentação é escrita. Muitas vezes, a linguagem utilizada na documentação ( uso de muitos termos técnicos, por exemplo) ou até mesmo o modo como ela foi redigida ( falta de objetividade, coerência) torna quase impossível para usuários iniciantes utilizarem os softwares.

    Elizabeth Oliveira

    14 setembro 2010 at 12:20 pm

  72. Concordo com a argumentação da autora, a documentação é fundamental para que novos usuários possam utilizar os sofwares livres de maneira satisfatória.

    Naiara

    17 setembro 2010 at 11:18 pm

  73. […] A importância da documentação em software para usuários iniciantes junho, 2010 76 comentários 4 […]


Deixe um comentário

Preencha os seus dados abaixo ou clique em um ícone para log in:

Logotipo do WordPress.com

Você está comentando utilizando sua conta WordPress.com. Sair / Alterar )

Imagem do Twitter

Você está comentando utilizando sua conta Twitter. Sair / Alterar )

Foto do Facebook

Você está comentando utilizando sua conta Facebook. Sair / Alterar )

Foto do Google+

Você está comentando utilizando sua conta Google+. Sair / Alterar )

Conectando a %s

%d blogueiros gostam disto: