文档的重要性

2025-05-24

文档的重要性

普罗洛戈

乌玛·达斯(Uma das)在 Twitter 上讨论了最近的一些事情,在欧盟中,我们的内容和想法是我们的​​文档想法和项目的一部分,但在极端情况下,onde:“sim é muito bom documente tudo” OU“não documente nada pois o código precisa ser legal”。

没有技术背景,我们的文档“boa”可能是 1 亿个详细信息的代码或 PDF。简单来说,最简单的方式是假装纪录片和Markdown辅助工具。

Markdown 的

Markdown 是一种营销语言,可以将其转换为 HTML 模型。包容性,esse artigo está sendo escrito em Markdown。

请使用文本标记,并在Microsoft Word应用程序问题中使用记事本

  • 卡贝萨略斯;
  • 马卡多雷斯;
  • 尼格利托语、意大利语、苏布林哈多语;
  • 分割;
  • 文本缺失;
  • ETC。

你可以在 VS Code 中找到你想要的东西!探索降价和使用的可能性。


Markdown 备忘单

文献类型

没有任何文档,但我们列出了所有这些内容。这是不专业的。请查看纪录片中的声音:

  • 埃斯图多斯
  • 问题
  • 拉取请求
  • 项目评估
  • 技术文献
  • 代码块 (Docblocks)

研究文献

Uma das coisas que somos ensinados desde criança enquanto na escola é, que é ""IMPORTANTE"" documentar as coisas de um jeito que você entenda, num caderno (assim como os íncas) pra ser um lugar de fácil acesso onde você possa buscar algo sobre aquele决心。

完全准备好程序,并执行以下操作。我希望我的文档能够取得进展,我希望我的速度不会加快。

没有我的研究模型,您可以根据实际情况进行设计,可以按照MAIS TOSCAS 的要求和装饰来进行我的研究,但存在一些缺陷,因此模型如下:

我和 Marcel 一起向 php 社区传播福音,Marcel(通过 Twitter)在我们的会议上提供了不同的文档,以帮助我们进行相关研究。

Como vai fazer isso, é inteiramente decidido por você, porém não esqueça de fazer sua colinha do assunto pra coach!

问题

开源世界中没有任何组织/企业/社区讨论开发存储库的决定。

作为 Github 上的常见问题,请详细讨论有关问题、错误、未来想法以及可能的问题。 Porém,se não 组织 vai virar bagunça。

VS Code 存储库问题

VS Code 存储库问题

Na 打印存在于问题上的模板:


Issue Type: **Bug**

Reproducing the bug:
* Ensure Hot Exit is set to onExit
* Create a new jupyter notebook
* Close or reload the window

Actual: **user is prompted to save**
Expected: ** no prompt, files will be restored on next reopen **

OS Version: Windows/Linux/Mac
VS Code Version: Code Insiders 1.66.0


 <details>
  <summary>Test A/B</summary>
  <p>Details about your test</p>
</details> 
Enter fullscreen mode Exit fullscreen mode

文档内容和结尾均有效,可以根据时间响应项目。作为一个contecendo 和como reproduzir 的Precisão,并且可以很有效地使用开源。

您可以使用 HTML 来制作 Markdown!一个想法,让您可以全权降价,以支持您的声音。

拉取请求

继续没有环境开源,vamos falar de como anunciar melhorias propostas à um projeto, o tal do PULL REQUEST

一个拉取请求的想法,它是一个新的参考,包括改进、实施、修补程序以及与项目相关的所有内容。联赛模型:

拉取请求示例

# Changelog

## Descrição curta da atividade

### Trello/Jira URL
*  [Task 123](https://linkmaneiro.com.br)

<!-- Se tiver blocos de código para mostruário -->
`` `php
echo "Seu código aqui";
`` `

### Mudanças
*  {descrição técnica curta da mudança}
*  {descrição técnica curta da mudança}
*  {descrição técnica curta da mudança}
Enter fullscreen mode Exit fullscreen mode

新的,我们需要组织文档,以保证项目的顺利进行,并进行分析。

项目评估

想要自由地享受“为客户提供服务”吗?如果你想将新项目记录下来,你会问“是否有一个想法?” e isso tudo vem de um negócio chamado ESCOPO do FUCKING PROJETO!

您可以根据客户的资料、文档进行同源和验证。例如,您可以在网站地图 (sitemap.xml) 上创建一个登陆页面,该页面主要包含所有页面、所有 XML 内容和文档,不包含任何内容和 TXT 或 MD 内容,以便为客户提供所需的信息。

项目主题文档的想法:

# Landing da Padaria do seu Zé

Cores: #ffccff, #ccffcc #fafafa #cafeee
Tecnologias: HTML, CSS e Bootstrap

* Landing
    * Hero
    * Pães que são produzidos
    * Horário de Funcionamento
    * Newsletter
* Sobre Nós
    * História da empresa
    * História do seu Zé
* Contato
    * Formulário que manda e-mail pro seu Zé
Enter fullscreen mode Exit fullscreen mode

开源项目文档:Basement LMS

## Basement LMS

A criação da LMS vai dar ênfase em uma facilidade maior para que outros desenvolvedores Laravel entendam como é a modelagem de tudo.


Essa aplicação ainda está em desenvolvimento, caso você queira integrar ao time, mande um e-mail para os mantenedores!

`` `
danielhe4rt: hey@danielheart.dev
`` `

### Projeto
1. [] Base do Projeto
   1. Tecnologias:
      1. [x] Bootstrap 4/5
      2. [x] Azure Stream 
      3. [x] Docker 
      4. [] Larastan
2. [] Autenticação
    * [x] Métodos base: Sessão
    * [] Métodos custom: Google, Github e Twitch
3. [] Cursos
    1. [] Modelagem Admin
       1. [X] Pagina de Criação de cursos
       2. [X] Pagina de Criação de módulos
          1. [] Ordenação de módulos
       3. [X] Pagina de Criação de Lições
          1. [X] Lições de Video
          2. [X] Lições em Artigos
          3. [] Lições em Quiz 
          4. [] Ordenação de Lições
    2. [] Modelagem User 
       1. [] Pagina inicial com todos os cursos
       2. [x] Pagina principal de um curso
       3. [x] Pagina para assistir o curso
4. [] Subscrição
    1. [] Método de pagamento: 
       1. [] Stripe
       2. [x] GerenciaNet
       3. [] Pagarme
       4. [] Paypal
    2. [] Formulário não pagante: Se não houver condições de comprar, deixa o salve que a gente libera!
5. Gameficação
   1. [] Leveling 
      1. [] Ao assistir uma aula
      2. [] Ao responder um questionário
   2. [] Tabela de EXP: definir um algoritmo de leveling pra não se preocupar com banco
6. Landing Page
   1. [x] Layout Base com integrações

[........] para mais informações, acesse o repo :p
Enter fullscreen mode Exit fullscreen mode

举例来说,一些可能的抽象文献是不同的项目主题,并且这些想法都有助于改善管理。 Novamente,一份关于VOCÊ EO 客户的文件!

技术文献

想要获得一个代码库,那么joaozinhohe4rtmariazinhahe4rt是否想获得一个巨大的代码

作为伟大的企业,我们为美国陆军的客户提供了文件法律法规,作为企业文件的一部分,我们的应用程序受到批评或存在于坟墓中。

最近我们在企业中实现了 ACL(访问控制列表),这是一个通过平台部分进行访问的想法。不过,PT-BR 中没有任何文献资料可供使用,但有时会破坏其性能。我们决定将意大利面作为项目的一部分docs,并结合项目的自述文件,将其制作为一部纪录片。

项目初始自述文件

如果您使用该功能,请通过以下步骤来完成此操作。不存在 um padrão,mas isso também conta como algo MUITO VALIOSO para a empresa e para as próximas pessoas que forem manter o projeto。

技术文档

Nisso,您joaozinhohe4rt可以mariazinhahe4rt在我们的企业中获取有关该功能的全部信息,并以书面形式记录下来。 Bacana né?

科迪戈集团

Agora vamos para o mais polêmico de todos para fechar com chave de ouro!所有文档块都是 abominam 或 amam com todas as forças。

有一个关于文档块的想法吗?纪录片以最小的方式描述了解剖学的基础。西甲无范例:


/**
 * Função para enviar e-mails com um template boladão pra galera que der like nesse post
 * 
 * @author danielhe4rt - hey@danielheart.dev
 * 
 * @param User $sender
 * @param Template $template
 * @param array $mailList
 * 
 * @return void
 */

public function handle(User $sender, Template $template, array $mailList): void
{
    $sender->send($template, $mailList);
}

Enter fullscreen mode Exit fullscreen mode

该文档块和字面注释是巨大的评论,是一种有趣的功能,可以通过直观和描述来发送说明。

与清洁代码的研究相比,这是一种自动描述的想法,也没有评论内容。

public function dispatchMailing(User $sender, Template $template, array $mailList): void
{
    $sender->sendMailTo($mailList)
        ->withTemplate($template);
}

Enter fullscreen mode Exit fullscreen mode

Não temos 或 docblock mas se você souber o bom e velho inglês, você vai saber EXATAMENTE o que está acontecendo ali dentro.使用功能中存在的文档块,可以使用 ATUALIZADAS 的功能,并通过验证文档块的方式来验证功能。这是一个主要的节奏问题。

你知道 docblocks 是什么吗?

最近的开源项目和开源项目,让我们对项目的使用产生了一些疑问。在应用程序完成后,请使用干净的代码和评论,并推荐您在常务工作中使用。

如果您想改变自己的生活,请使用其他推荐的方式使用文档块,然后将项目发送给不同的人,并根据公关生活的主要标准进行开发。

结论

纪录片和一些重要的价值都不是从开始的,而是在细节上与其他问题有所不同。

目前,我们已发布了有关 Twitter 帖子、项目的问题和 Pull 请求的文档,以及有关项目的信息。

Se você curtiu o conteúdo, deixa aquele likezinho maroto, compartilha no Twitter/IG e marca nois e até a próxima 💜

修订者: Flaubordi e Nandaknwls

文章来源:https://dev.to/danielhe4rt/a-importancia-de-uma-boa-documentacao-5686
PREV
Nginx:关于 proxy_pass 的一切 首先,关于 https 的说明 一个简单的例子 是否要斜线 $uri 和 $request_uri 捕获正则表达式 使用 try_files 和 WebApp 作为后备方案 即使并非所有上游主机都可用,也让 nginx 启动 proxy_pass 的更好的日志记录格式 结论
NEXT
Code-it 笔记:创建你自己的笔记!📝