Como escrever um procedimento

Onde cada coisa fica

• Directorysrc/content/docs/

  • Directoryrotinas/ o que o setor faz, do início ao fim (uma pasta por rotina)

    • …
  • Directorysistemas/ onde clicar, por sistema

    • …
  • Directoryreferencia/ tabelas, legislação, glossário, contatos

    • …
• Directorysrc/assets/prints/ imagens, uma pasta por procedimento

  • …
• Directorypublic/materiais/ PDFs para enviar ao contribuinte

  • …

Rotinas apontam para as páginas de sistema e de referência em vez de repetir o conteúdo. Se a tela mudar, corrige-se uma página só.

Modelo de página

---
title: Verbo + objeto (ex.: Analisar pedido de dispensa)
description: Uma frase; aparece na busca.
tipo: procedimento        # procedimento | orientacao | referencia | conceito
sistemas: [Atende.Net]
publico: [Fiscalização]
responsavel: Setor de Fiscalização do ISS
versao: '1.0'
revisado_em: 2026-09-25
revisar_ate: 2027-03-31
base_legal: [LCM 106/2003 art. 14]
pendencias:
  - O que ainda falta documentar
---

import { Steps } from '@astrojs/starlight/components';
import Print from '@components/Print.astro';
import Checklist from '@components/Checklist.astro';
import BaseLegal from '@components/BaseLegal.astro';
import Pendente from '@components/Pendente.astro';
import tela1 from '@assets/prints/minha-rotina/01-tela.png';

**Quando usar:** ...

<Steps>

1. Faça isto.

   <Print src={tela1} alt="Descreva o que a tela mostra" />

2. Depois isto.

</Steps>

<BaseLegal>Norma e artigo.</BaseLegal>

Componentes disponíveis

Componente	Para quê
Steps	Passos numerados
Print	Print de tela com ampliação ao clicar
Checklist	Conferência de documentos; as marcações ficam no navegador de quem usa
Arvore	Triagem por perguntas até o procedimento certo
BaseLegal	Quadro de fundamentação
Pendente	Trecho que falta documentar
Aside	Dica, nota, atenção ou perigo

Regras para prints

Sigilo fiscal (art. 198 do CTN)

Nenhum print pode mostrar CPF, CNPJ, nome, endereço ou valor de contribuinte real. Pixelize ou use dados fictícios antes de salvar a imagem no projeto.

Recorte a barra do navegador e a barra de tarefas quando não ajudarem. Use setas ou marcações só no que o passo pede. Nomeie os arquivos pela ordem e pelo assunto: 03-incluir-beneficiario.png.

Revisão

Toda página com revisar_ate aparece em Revisões e pendências. Tabelas que mudam todo exercício (como o VLP) revisam em dezembro.