O projeto FreeBSD
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Esta página contém os detalhes de um projeto de redação técnica aceito para a
Google Season of Docs.
Resumo do projeto
- Organização de código aberto:
- O Projeto FreeBSD
- Redator técnico:
- The King of Toasters
(em inglês)
- Nome do projeto:
- Escrever páginas de manual ausentes, adicionar seções EXEMPLO às páginas de manual
- Duração do projeto:
- Duração padrão (três meses)
Project description
Escrever páginas man ausentes:
Há uma lista de manpages ausentes em
https://wiki.freebsd.org/MissingManpages. Comece a escrever o maior número possível de páginas de manual dessa lista. Com a ajuda do mentor, encontre o
autor ou alguém que tenha mudado recentemente o arquivo de origem que a página do manual
em questão aborda para obter informações e detalhes.
Adicionar seções EXEMPLO às páginas do manual:
As páginas de manual do FreeBSD incluem em muitos lugares seções EXAMPLE,
que descrevem o uso básico do utilitário ou comando descrito nelas. A
wiki do FreeBSD tem uma lista de páginas de manual sem exemplos (https://wiki.freebsd.org/ManPagesWithoutExamples). Adicione o maior número possível de exemplos
a essas páginas de manual nos casos em que eles façam sentido. Crie uma maneira geral de apresentar o comando/utilitário nessas seções (por exemplo, primeiro a introdução rápida, depois exemplos mais avançados) e aplique isso às páginas man que descrevem utilitários/comandos semelhantes. Dessa forma, os exemplos têm uma abordagem consistente
e o leitor pode encontrar as coisas com mais facilidade.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Não contém as informações de que eu preciso","missingTheInformationINeed","thumb-down"],["Muito complicado / etapas demais","tooComplicatedTooManySteps","thumb-down"],["Desatualizado","outOfDate","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Problema com as amostras / o código","samplesCodeIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-07-25 UTC."],[],["The FreeBSD Project, in collaboration with technical writer \"The King of Toasters,\" will undertake a technical writing project focused on man pages. The project includes creating missing man pages from a specified list, using source file authors for guidance. Additionally, the project will add EXAMPLE sections to existing man pages that lack them, following a consistent structure of introductory and then advanced examples to improve readability and usability. The project duration will be three months.\n"]]
