Guia de Criação de Tópicos

Comunidade
1

Seja bem vindo ao guia de criação de tópicos da nossa Comunidade!

Aqui você encontra dicas, convenções de formatação e boas práticas para se comunicar com os membros da comunidade!

Seja Educado

Esta Comunidade não é construída apenas por colaboradores da Latromi. Aqui usuários, desenvolvedores, clientes e curiosos compartilham conhecimento, ajudam uns aos outros e ficam por dentro das novidades associadas à plataforma.

Aqui cultivamos a educação e a gentileza na comunicação. Por isso, não perca a oportunidade de começar com um “Olá”, pedir “por favor” e agradecer.

Seja Claro

Ao criar um tópico, tenha em mente que ele é para todos. Portanto, deixe claro qual é o contexto do que está sendo redigido:

  • Se for um tutorial ou solução de problemas, forneça uma Visão Geral, situando o leitor sobre o problema que o tópico resolve.

  • Se for um estudo de caso (case), deixe claro o setor ao qual se refere (transporte, indústria, agro, etc) e a proposta de valor alcançada.

  • Se estiver reportando um erro, forneça todas as informações disponíveis para a simulação do problema ou pistas para chegar até ele, como arquivos de log e screenshots.

  • Se estiver sugerindo um novo recurso, deixe claro o motivo que torna ele necessário.

Formatação

A linguagem usada na formatação dos tópicos é majoritariamente Markdown. Clique aqui para ter visão geral sobre este tipo de formatação.

Títulos / Heading

Os títulos de um tópicos são organizados por níveis, que iniciam a partir de h1 e seguem com h2, h3 e assim por diante.

A seguir alguns cuidados que devem ser tomados ao utilizar os títulos:

  • O título h1 é reservado ao título do tópico portanto, inicie a marcação dos títulos sempre a partir de h2.

  • Além disso, procure usar a hierarquia correta dos títulos. Por exemplo, evite usar um h3 antes de um h2.

  • Use títulos curtos. Evite usar textos que na verdade deveriam fazer parte da explicação, e não do título.

Para criar um título em um tópico, basta inserir # no início da linha.

Veja abaixo os exemplos de cada nível de título e sua respectiva marcação:

Item h2

## Item h2

Item h3

### Item h3

Item h4

#### Item h4

Resumo sobre a utilização dos títulos:
  • O h é a abreviação de “heading” (cabeçalho) e o número indica o nível.
  • O título h1 é reservado ao título do tópico, por tanto, inicie a marcação dos títulos sempre a partir do h2.
  • Os títulos devem ser hierárquicos. Por exemplo, evite usar um h3 antes de um h2.

Código de Programação

Sempre que for inserir um código de programação ou conteúdo de log, use a formatação de código.

Formatação em linha

Basta inserir o código entre crases (`).

Exemplo: Use o comando `SELECT` para selecionar os registros.

Resultado: Use o comando SELECT para selecionar os registros.

Formatação em bloco

A formatação em bloco deve ser usada sempre que o código possuir mais de uma linha.

Por exemplo:

SELECT *
FROM tabela
WHERE id = 1

```
SELECT *
FROM tabela
WHERE id = 1
```

As cores usadas da formatação (highlight) são identificadas automaticamente, mas o ideal é especificar a linguagem para que o sistema faça a formatação correta. A linguagem pode ser passada logo após os 3 primeiros crases, dessa forma:

```sql

Segue a relação das siglas para formatação de cada linguagem:

Sigla Linguagem
sql SQL
js JavaScript
css CSS
html HTML
cs C#
text Texto sem formatação

Arquivos / Anexos

Arquivos de imagens podem ser adicionados às postagens, mas use este recurso com moderação.

  • Sempre que possível, tente se expressar através do texto. Isso ajuda nas buscas.
  • Evite anexar Screenshots de código fonte. Use a formatação de Código de Programação apresentada no item acima para isso.
3 curtidas