Giter VIP home page Giter VIP logo

projeto-alura's Introduction

Projeto Alura - Documentações da Bytebank

Contexto

Este repositório faz parte do curso de formação de Technical Writing, da Alura. Nele, você vai encontrar modelos de documentações técnicas que serão abordadas nas aulas com objetivo de fixar seus conhecimentos e trazer modelos de base para você iniciar neste universo de documentar.

Tipos de documentação

O curso irá abordar 6 formatos de documentação técnica:

  1. Documentação Funcional
  2. Tutorial
  3. Guia how-to (How-to guide)
  4. Troubleshooting
  5. Documentação de API
  6. Release Notes
  7. Guia de Início Rápido (Quick Start Guide)
  8. Perguntas frequentes (FAQ)

projeto-alura's People

Contributors

marimoreiratw avatar

Stargazers

Janaina Malaquias avatar Vitória Avendaño avatar João Paulo Novais avatar Chris Berenguer avatar  avatar Kauana Henriques avatar  avatar  avatar Lúcio Noleto avatar  avatar João Paulo Carvalho avatar  avatar  avatar Gabriell Lopes avatar  avatar  avatar

Watchers

 avatar  avatar Ramon Gallo avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.