Parágrafos, sentenças e títulos

A documentação técnica deve ser precisa, clara e concisa. É por isso que priorizamos a redação de sentenças simples e curtas. Uma boa prática quando nos deparamos com sentenças complexas é tentar dividi-las em duas diferentes.

✅ A integração não é complexa. Pode ser feita de duas maneiras distintas
❌ A integração, que pode ser feita de duas maneiras distintas, não é complexa

Os parágrafos também devem ser curtos, preferencialmente com menos de 5 sentenças simples. Quanto mais longos forem, mais complexo se torna para o leitor localizar as informações necessárias e se concentrar em pontos específicos.

No caso dos títulos, eles devem refletir o conteúdo de cada seção de forma concisa e simples. Para as seções que envolvem etapas de integração ou configuração, é preferível usar verbos nominalizados (Configuração de integração).

Para os subtítulos dentro de uma seção com título nominalizado, priorizamos o uso de verbos no infinitivo (Criar preferências, Enviar um pagamento).