feat(faq): create a frequent asked questions page #1210
Conversation
|
@gabrielsozinho is attempting to deploy a commit to the TabNews Team on Vercel. A member of the Team first needs to authorize it. |
|
Eu também gostaria de compartilhar alguns screenshots de quando eu estava criando a página e o Copilot deu algumas sugestões (ou ideias) interessantes 😅 Ele presumiu que o TabNews tinha moderadores, uma página chamada Guia de Publicação (
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@gabrielsozinho acho muito legal a ideia de ter uma página FAQ! Sobre utilizar um link de uma publicação do tabnews me fez pensar se isso seria politicamente correto, mesmo o conteúdo sendo de qualidade e ideal para essa FAQ. Podemos gerar conflitos com outros usuários do tabnews. O que acham sobre o assunto? |
Concordo totalmente com o que você falou. Além disso existe a possibilidade de o autor (nesse caso você) ou algum moderador alterar o conteúdo da publicação para fazer propaganda ou algo do tipo. Eu não estou falando que isso irá acontecer, inclusive acredito no inverso disso, mas não podemos dar margem para isso. E se alguém mal intencionado conseguir acesso à conta de uma das pessoas que eu falei? Talvez o melhor seria adicionar o conteúdo diretamente na sessão wiki ou em algum outro lugar do repositório. 👍🏻 |
There was a problem hiding this comment.
Os comentários que coloquei são sugestões minhas, não estou batendo o martelo.
Aproveitando para realizar outra pergunta: por quê usamos o Viewer do ByteMD no FAQ e nos Termos de Uso? Ele tem algumas formatações úteis, mas não tem nem âncora nos headers, e pode ser uma dependência ruim caso troquemos o ByteMD por outra biblioteca.
Acho "ok" usarmos aqui, já que a página de Termos de Uso já está usando também, mas queria saber se existe um motivo.
| ## Como funcionam os TabCashs? | ||
| Da mesma forma que as TabCoins, TabCashs são como moedas digitais do TabNews que poderão ser usadas no sistema de Revenue Share (ainda não implementado). | ||
|
|
||
| Atualmente a única forma de ganhar TabCashs é avaliando um conteúdo com TabCoins, você ganha 1 TabCash por avaliação. |
There was a problem hiding this comment.
Estou sem ideias agora para elaborar um texto como fiz para a seção de TabCoins, mas tenho uma sugestão para esse último parágrafo:
A única forma de ganhar TabCash é avaliando uma publicação ou comentário de outras pessoa. Sempre que você avaliar algo, perderá 2 TabCoins e receberá 1 TabCash.Eu mudei bastante coisa do parágrafo, mas o ponto central dessa sugestão é remover a palavra "Atualmente". O FAQ sempre deverá refletir o "atualmente", então não precisamos falar como funcionará ou se irá mudar ou não, porque tudo isso é incerto no presente.
| <div id="onde-fazer-testes"></div> | ||
|
|
||
| ## Onde fazer testes? | ||
| Testes das mais variadas formas devem ser feitos no ambiente de homologação. Você pode acessar [esse link](https://github.com/filipedeschamps/tabnews.com.br/deployments/activity_log?environment=Preview) para ver a lista de deploys e depois basta clicar em \`View deployment\` no deploy mais recente para acessar o ambiente. |
There was a problem hiding this comment.
Não sei se o GitHub mudou, mas agora a orientação pode ser:
... para ver a lista de deploys e clicar em algum link da lista de `Active deployments` para acessar o ambiente.| ## Onde fazer testes? | ||
| Testes das mais variadas formas devem ser feitos no ambiente de homologação. Você pode acessar [esse link](https://github.com/filipedeschamps/tabnews.com.br/deployments/activity_log?environment=Preview) para ver a lista de deploys e depois basta clicar em \`View deployment\` no deploy mais recente para acessar o ambiente. | ||
|
|
||
| Por ser um ambiente diferente, você precisará criar uma nova conta lá. |
There was a problem hiding this comment.
Acho válido lembrar que, mesmo sendo homologação, continua precisando validar o e-mail.
Por ser um ambiente diferente, você precisará criar uma nova conta e confirmar o e-mail.
| <div id="como-posso-fazer-sugestoes-e-ou-reportar-bugs"></div> | ||
|
|
||
| ## Onde posso fazer sugestões e/ou reportar bugs? | ||
| Para sugestões, pedimos que abra uma issue no [repositório do projeto](https://github.com/filipedeschamps/tabnews.com.br), pois desta forma outras pessoas poderão se beneficiar, incluindo participar adicionando novos pontos de vista ou novas dúvidas. |
There was a problem hiding this comment.
Não acho que precise explicar o porquê de usar o GitHub. Também podemos adiantar citando para não abrir casos de falhas de segurança:
Para sugestões de melhorias ou para reportar bugs que não envolvem informações sensíveis ou falhas de segurança, você pode abrir um issue no [repositório do TabNews no GitHub](https://github.com/filipedeschamps/tabnews.com.br).| ## Onde posso fazer sugestões e/ou reportar bugs? | ||
| Para sugestões, pedimos que abra uma issue no [repositório do projeto](https://github.com/filipedeschamps/tabnews.com.br), pois desta forma outras pessoas poderão se beneficiar, incluindo participar adicionando novos pontos de vista ou novas dúvidas. | ||
|
|
||
| Você também poderá criar uma [nova publicação](https://www.tabnews.com.br/publicar) no próprio TabNews para que todos possam participar. |
There was a problem hiding this comment.
Eu removeria esse parágrafo. Prefiro que a pessoa abra um issue e, conforme o andamento da discussão, a pessoa (ou um terceiro) decida criar uma publicação para obter mais atenção (atenção para obter mais "sugestões de implementação", não atenção "para colocar pressão e implementarem logo").
| <div id="test"></div> | ||
|
|
||
| ## Posso publicar meus projetos aqui? | ||
| Sim, uma explicação com detalhes técnicos e suas experiências na criação do projeto será muito bem-vinda. Para isso você deve usar a tag \`Pitch\` no título do post. |
There was a problem hiding this comment.
Acho que um exemplo seria legal:
Sim, uma explicação com detalhes técnicos e suas experiências na criação do projeto será muito bem-vinda. Para isso você deve usar a tag \`Pitch\` no título do post, por exemplo: `Pitch: TabInvest — Um TabNews sobre investimentos`.| ## Posso publicar meus projetos aqui? | ||
| Sim, uma explicação com detalhes técnicos e suas experiências na criação do projeto será muito bem-vinda. Para isso você deve usar a tag \`Pitch\` no título do post. | ||
|
|
||
| Lembre-se que se o post for apenas uma propaganda do seu projeto ou não tenha relação com tecnologia, ele poderá ser removido pela moderação do TabNews. |
There was a problem hiding this comment.
Acho importante apontarmos para os Termos de Uso e relembrarmos sobre "Que tipo de conteúdo eu posso publicar no TabNews?":
Uma apresentação de um projeto que você está envolvido deve seguir as mesmas regras de qualquer outra publicação: leia os [Termos de Uso](/termos-de-uso) e o tópico [Que tipo de conteúdo eu posso publicar no TabNews?](link). Publicações com foco exclusivo comercial são expressamente proibidas.|
|
||
| Lembre-se que se o post for apenas uma propaganda do seu projeto ou não tenha relação com tecnologia, ele poderá ser removido pela moderação do TabNews. | ||
|
|
||
| Caso você queira saber o significado da palavra \`Pitch\`, nada mais é do que uma apresentação curta e objetiva de um projeto, produto ou ideia com a intenção de despertar o interesse de outras pessoas. |
There was a problem hiding this comment.
Tenho receio de explicar o que é pitch assim porque a pessoa pode ficar com a imagem de que pitch é uma propaganda. No TabNews um pitch deve ser um conteúdo, e o conteúdo ser o atrativo para as pessoas se interessarem.
Além disso, talvez fique melhor explicar o que é pitch logo no primeiro parágrafo, onde a palavra foi mencionada. Assim não há um vai-e-volta de assuntos.
| ## Como funcionam as TabCoins? | ||
| As TabCoins são como moedas digitais do TabNews que podem ser usadas para avaliar outras postagens e comentários. | ||
|
|
||
| Você pode ganhar TabCoins das seguintes formas: | ||
| - Ao criar um conteúdo (seja ele um conteúdo que vá para a home ou uma resposta a outro conteúdo) você ganha 2 TabCoins. | ||
| - Ao ter um conteúdo avaliado positivamente você ganha 1 TabCoin (por avaliação). | ||
|
|
||
| Você também pode perder TabCoins nos seguintes casos: | ||
| - Quando você avalia um conteúdo você gasta 2 TabCoins. | ||
| - Quando uma pessoa avalia negativamente o seu conteúdo você perde 1 TabCoin. | ||
| - Quando uma publicação sua é apagada (seja por você ou seja pela moderação) você perde 2 TabCoins + todas as avaliações positivas. |
There was a problem hiding this comment.
Como o TabNews vai evoluindo de tempos em tempos na forma de obter Tabcoins, acho que não precisamos informar os valores exatos. O meu texto não está no que eu consideraria "pronto para o merge", mas passa a ideia que tenho em mente:
## Como funcionam as TabCoins?
TabCoins são o ponto central do TabNews para estimular a geração de conteúdo de qualidade. Existem algumas maneiras diferentes de se ganhar TabCoins, mas todas envolvem a criação de conteúdo que foi avaliado positivamente por outros usuários.
Para que um usuário possa avaliar publicações e comentários de outras pessoas, precisará gastar 2 TabCoins. Isso significa que, antes de avaliar publicações de outras pessoas, é preciso gerar valor criando uma boa publicação ou comentário.
As formas de ganho de TabCoins são:
- **Criando uma publicação ou comentário:** existe um algoritmo que leva em consideração os TabCoins das suas publicações mais recentes para definir quantos TabCoins você ganhará ao criar uma nova publicação.
- **Recebendo votos positivos:** quando outro usuário avalia positivamente seu conteúdo.
- **Recompensa diária:** você pode ganhar TabCoins ao acessar o TabNews pelo menos uma vez no dia. Existe um algoritmo que leva em consideração as qualificações das suas publicações mais recentes e também a quantidade de TabCoins que você possui. Quanto melhor avaliadas forem suas publicações e menos TabCoins você possuir, mais receberá na recompensa diária.
Seguindo o mesmo raciocínio, você pode perder TabCoins:
- **Ao apagar uma publicação ou comentário:** você perderá os TabCoins que ganhou ao criar a publicação ou o comentário, caso tenha ganhado algum TabCoin, e também perderá os TabCoins que ganhou com as avaliações positivas nessa publicação. O mesmo vale para caso um moderador apague uma publicação sua.
- **Recebendo votos negativos:** quando outro usuário avalia negativamente seu conteúdo.
- **Ao avaliar uma publicação:** para avaliar publicações e comentários de outras pessoas, você precisará gastar 2 TabCoins.Deixei o valor exato ao votar para não causar um medo do leitor pensar "vou perder TabCoins ao avaliar, mas quantos?" e acabar não votando.
Algo que não gostei do texto que sugeri foi de ficar citando publicação e comentário. Fiz isso porque algumas pessoas não interpretarão que "comentário" é uma "publicação".
| ## Que tipo de conteúdo eu posso publicar no TabNews? | ||
| Consideramos conteúdos de valor concreto: notícias, artigos, tutoriais, indicações, curiosidades, perguntas bem formuladas ou qualquer outro tipo de conteúdo que poderá fazer alguma diferença na vida de quem trabalha em áreas diretamente ou indiretamente relacionadas ao desenvolvimento de software. | ||
|
|
||
| Conteúdos que não se encaixam nessa definição poderão ser removidos pela moderação do TabNews. Então antes de criar uma publicação, leia os [Termos de Uso](/termos-de-uso) e pense se o conteúdo que você quer publicar se encaixa nessa definição. |
There was a problem hiding this comment.
Uma das maiores críticas que temos sobre os Termos de Uso é que "conteúdo de valor concreto" não está bem definido. Agora estou sem sugestões para melhorar esses dois parágrafos.
Já adianto que a definição mais concreta deve estar nos Termos de Uso, e aqui deve ser uma definição mais amigável, talvez com exemplos, e continuar citando os Termos de Uso.
|
Gabriel, obrigado pela colaboração! Esse PR está sendo continuado em #1581, com as modificações propostas nos comentários. |
Nesse PR eu crio a página de FAQ (Perguntas Frequentes) e adiciono um link para ela no footer.
Atualmente a página responde as seguintes perguntas:
Se você quiser ver a página inteira, eu tirei um screenshot e você pode ver nesse link: https://user-images.githubusercontent.com/90806505/210378200-54fdedb2-952e-4f69-b179-c39c50ddd3a1.png
Criei o PR em draft porque o ideal é discutirmos algumas coisas que foram feitas antes de ir pra produção, como melhorias nos textos, novas perguntas e/ou a existência ou não dessa página.
Observações
Na seção
Como posso contribuir com o TabNews?eu adicionei o link de uma postagem do @rodrigoKulb ensinando boas práticas para criar um Pull Request. Será que esse conteúdo não deveria ser adicionado diretamente aqui no repositório ou em uma página no próprio TabNews?Eu tentei implementar o que o @ezequiaslopesdasilva falou nesse comentário: Atualizar Termos de Uso (e colocar link no cadastro) #1153 (comment) só que de outra forma. Eu criei uma div acima de cada tópico com o que seria o id daquela sessão.
No entanto isso não funcionou, quando eu adicionava
#como-funcionam-as-tabcoinsao final do link simplesmente não ia para aquela seção. Inspecionando o código compilado, vi que o id gerado era diferente, ficava dessa forma#user-content-idqueeraprasergeradoe só assim funcionava:Alguém sabe o porquê disso ocorrer e como resolver isso?
Ah, e aqui estão algumas perguntas que talvez devessem ser adicionadas na página. Gostaria de saber a opinião de vocês sobre cada uma e uma ideia de texto que vocês adicionariam nelas.
Também, peço sugestões de outras perguntas.