Permalink
Browse files

rev e add faq

  • Loading branch information...
ppKrauss committed Jul 30, 2017
1 parent 7d669ea commit 81d697d6691da4fcf9774997634caef1f4020f8d
Showing with 82 additions and 4 deletions.
  1. +15 −4 README.md
  2. +67 −0 docs/faq.md
@@ -1,23 +1,34 @@
# Suporte e infraestrutura da OKBR
# Suporte

Conteúdo orientado à Equipe de Suporte:
Contéudo orientado à Equipe de Suporte:

* [Termo de Referência dos Serviços da Equipe de Suporte da OKBr](docs/termo.md)

* [Infraestrutura Digital da OKBr](docs/infra.md)

* [webservers](webservers)

* Gestão dos *datasets* e arquivos no [oficial-backups](https://git.ok.org.br/oficial.news), em conformidade com diretivas da OKFN, [frictionlessdata.io/data-packages](http://frictionlessdata.io/data-packages/), etc.

Conteúdo orientado ao usuário em geral:

* [Dúvidas](#duvidas)
* [Dúvidas básicas](#duvidas) (abaixo)
* [Gestão de _tickts_ do Suporte OKBr](docs/tickets.md)
* [Perguntas e respostas](docs/faq.md) (dúvidas mais específicas)

-----

A equipe de suporte realiza uma série de pequenos atendimentos e pequenos serviços, que precisam ser registrados de forma transparente, tanto para a prestação de contas, como para tirar dúvidas e permitir o acompanhamento da comunidade.

Neste repositório são registradas as regras, *datasets* e os _tickets de suporte_, para a gestão e transparência da Equipe de Suporte da OKBr.

-----

## Dúvidas

* QUAL O ENDEREÇO OFICIAL DO SUPORTE?<br/> [`suporte.ok.org.br`](http://suporte.ok.org.br). Para citar um *ticket de suporte* na forma de link, use `suporte.ok.org.br/ticket/{numero}`. <br/>PS: ambos são redirecionamentos para este site, com HTTP.
* QUAL O ENDEREÇO OFICIAL DO SUPORTE?<br/> [`suporte.ok.org.br`](http://suporte.ok.org.br). Para citar um *ticket de suporte* na forma de link, use `suporte.ok.org.br/ticket/{numero}`. <br/>PS: ambos são redirecionamentos para este site, via HTTP.

* O QUE SÂO OS _TICKETS DE SUPORTE_?<br/> São o mecanismo de controle dos chamados à Equipe de Suporte. Cada vez que você descobre aguma **falha na infraestrutura da OKBr**, pode descrevê-la abrindo ticket de aviso de bug ou simplesmente de dúvida, para conferir se é de fato uma falha, ou se pode vir a ser uma sugestão de melhor. Quem rotula se era falha, dúvida ou outra coisa, é a própria equipe, não se preocupe. <br/>Se a dúvida for respondida ou a falha for corrigida, você pode então "fechar o ticket" (se demorar ele fecha por inatividade). Os tickets, por serem numerados e ficarem permanentemente registrados, podem ser utilizados também para discussões técnicas e **controle dos contratos de suporte**. Veja maiores detalhes na [Gestão de _tickts_ do Suporte OKBr](docs/tickets.md).

* COMO CONFERIR TICKET DE SUPORTE EM ABERTO?<br/> É o link *"Issues"* no menu de navegação superior (citar [`suporte.ok.org.br/tickets`](http://suporte.ok.org.br/tickets)). Para encontrar o ticket ou assunto desejado, basta navegar, ou incluir uma palavra-chave mais ao lado de `is:issue is:open` (depois tecle *enter*)... Ou ainda [navegar por rótulos](https://github.com/okfn-brasil/suporte/labels), clicando no rótulo desejado.

@@ -0,0 +1,67 @@
# PERGUNTAS FREQUENTES
Perguntas e respostas com mais explicações.

Existem também dezenas de tutoriais sobre "Github issues" (cada *ticket* é uma *issue*), ver por exemplo [Mastering Issues](https://guides.github.com/features/issues/). E na própria OKBr temos dezenas de outros exemplos... Para quem não é programador o melhor é o [histórico de *issues* do projeto Identidade-digital](Exemplos da Indetidade: https://github.com/okfn-brasil/identidade-digital/issues?q=is%3Aissue%20).

A seguir

> As *perguntas destacadas* assim.
## Na página do ticket

Entre em qualquer um dos [tickets listados no histórico geral (abertos e fechados)](https://github.com/okfn-brasil/suporte/issues?utf8=%E2%9C%93&q=is%3Aissue%20).

> Às vezes parece um processo de trabalho, coisa de programador, às vezes parece uma discussão simples do DiscussOKbr... Como olhar para a página do ticket?
Se você já se acostumou com o [DiscussOKBr](http://discuss.ok.org.br), olhe do mesmo modo:

* O tópico, dado pelo **título** da página e **número de ticket**, e descrito pelo comentário que vem logo embaixo; é o que caracteriza o assunto do *ticket* e seu contexto. <br/>Tem sempre indicado o autor e podem ter coloridos os rótulos atribuídos ao assunto ou status de andamento do ticket.<br/>Abaixo do título sempre vem indicado também se é "ticket em aberto" (em verde *"!Open"*) ou "ticket encerrado" (em vermelho *"!Closed"*).

* Abaixo, os vários **posts** de comentários, que são de fato uma discussão.<br/>Cada post tem seu autor. Pode ser gente da comunidade ou da equipe de suporte.

* Se for só para endoçar, dê seu "like" (ou "up vote") no tópico ou no post que deseja endoçar.


## Principais tipos e motivações para os tickets

A [listagem dos rótulos](https://github.com/okfn-brasil/suporte/labels) dá uma primeira ideia quanto aos tipos. Os rótulos são como "facetas" atribuidas ao *ticket* por você e/ou pela equipe técnica. A grosso modo podem ser agrupados:

* Motivo: "Aviso de vandalismo", "Bug na infra-basica", "Bug na infra-comunic", "Proposta", "Diretiva", "pedido de acolhimento", "pedido infra-basica", "Pergunta";

* Status ou modo de tratamento na resposta ao ticket: "EM ANDAMENTO", "empreitada";

* Avaliação do ticket: "duplicate", "Futuro", "invalid", "urgente".

...Podemos [agrupar por cores](https://static.robinpowered.com/blog/images/github-tagging-style/robin-github-issue-tag-system.png), basta postar um ticket sugerindo!

## Dinâmica da participação nos tickets

> Gostaria de entender direitinho a questão principal de criação dos tickets (...) Vejo que isso está andando, mas ainda não consegui me familiarizar. Gostaria de entender isso para que eu possa participar da melhor forma e também contribuir.
A primeira página do [suporte.ok.org.br](http://suporte.ok.org.br) já fornece importantes dicas. As motivações são resumidas acima nos tipos de rótulo, e navegando pela [listagem do histórico de tickets](https://github.com/okfn-brasil/suporte/issues?utf8=%E2%9C%93&q=is%3Aissue%20) você também capta pelos exemplos (ver aqueles com balãozinho e número indicando mais de 2 comentários).

Mas se você quer contribuir, **pode ajudar** de várias formas:

* a melhorar uma descrição de bug mal feita, postantando mais um comentário descritivo do problema.
* responder uma dúvida muito básica, mesmo sendo alguém "de fora" da equipe do suporte.
* efetivar o suporte, mesmo não sendo da equipe de suporte.

A participação nas discussões dos tickets é livre! Lembre-se que o foco é a solução de problemas, em geral com escopo já delimitado por [rótulos coloridos](https://github.com/okfn-brasil/suporte/labels).


> Sinto que algumas coisas, como os [tickets de Diretiva](https://github.com/okfn-brasil/suporte/labels/Diretiva) precisam de "filtro" antes de irem a público, poderiam ser conversadas internamente com outras equipes (ex. Comunicação, Contabilidade, etc.) antes de serem registradas como tickets de suporte.
Sim, é comum esse problema, mas a ferramenta e a equipe de suporte não podem fazer nada para ajudar: depende do bom senso das pessoas.

O que os membros da equipe e voluntários podem fazer para ajudar, é avisar a pessoa que fez algum equívoco e em seguida, por outros canais, tal como e-mail, dar o devido encaminhamento ou acolhimento. <br/>PS: tickets fechados podem ser ignorados, a Internet inteira sabe que não se deve levar a sério *closed issues* do Github. A interface também ajuda a reduzir a exposição deles.

> No [ticket #16](https://suporte.ok.org.br/ticket/17) por exemplo, entendi que a ideia é levar as discussões que começam nas matérias para o [DiscussOKBr](https://discuss.ok.org.br), não é? Acho muito válido mesmo. Na prática, como isso funcionaria? Como posso colaborar?
Em primeiro lugar, se gostou, vai lá no [ticket #16](https://suporte.ok.org.br/ticket/17) e dá um *up vote*! Clique no botão <big>`+😁`</big> e vai aparecer a opção "<big>👍</big> joinha".

As maneiras de colaborar são comentadas acima... Quanto a colaborar discutindo, ou à dinâmica que leva da proposta ao encerramento, o melhor é pegar o espírito da coisa pelos exemplos... Veja os [exemplos da indentidade-digital](https://github.com/okfn-brasil/identidade-digital/issues?q=is%3Aissue+is%3Aclosed).




Abs

0 comments on commit 81d697d

Please sign in to comment.