BreveEsquemaTutoriales

Breve Esquema de Tutoriales

Si usted tiene una idea para un tutorial, pero no desea escribir todo, puede utilizar este formato para proporcionar la documentación y el equipo web con toda la información que ellos necesitan terminan el tutorial. Las partes más importantes son:

  • Descripción de la tecnología que está ilustrando
  • Pasos para reproducir
  • Comienza el proyecto si es necesario
  • El producto acabado
  • El resultado esperado cuando usted ejecute/implemente el proyecto

Introducción


Utilice esta sección para proporcionar un breve resumen de la tecnología que está presentando. Centrarse en por qué un usuario desea utilizar esta tecnología y proporcione ejemplos del mundo real y casos de uso de la tecnología. Si NetBeans tiene algunas características especiales que hacen uso de esta tecnología de manera fácil, es posible que desee describir cuales son.

Pasos para reproducir


Esta es una de las partes más cruciales. Usted no tiene que dar los detalles de los pasos pequeños. Por ejemplo, si usted necesita crear un proyecto, usted no tiene que listar  "Seleccione Archivo> Nuevo proyecto ..." .Vamos a evitar estos pasos  en cuanto sea necesario. Lo importante es el listado de todas los pasos necesarios y el listado de cualquier código que el usuario tiene que llenar en el.

Comenzando el proyecto


Es agradable proporcionar un proyecto pre-creado ya que contiene parte del código básico para el ejemplo. Adjuntar archivos comprimidos del proyecto a la página wiki para su tutorial. Recuerde que debe limpiar su proyecto y eliminar el directorio privado antes de crear el zip. Además, si usted tiene varios proyectos que dependen el uno del otro, debe definir las rutas a los proyectos con los vínculos relativos en project.properties en lugar de private.properties.

Solución


Esta es la parte más crucial. Muchas personas simplemente abren la solución terminada de inmediato y proceden a meter el código. Mucha gente ve su código, así que asegúrese de que Sun puede estar orgullosa de el(no usar malas prácticas de codificación, explicación adecuada de comentarios Javadoc explicando lo que está sucediendo en el código, etc)


Resultados previstos


Lista de lo que el usuario debe ver cuando se ejecuta/ implementa el proyecto. También lista cualquier información de solución de problemas para resolver problemas comunes.

Not logged in. Log in, Register

By use of this website, you agree to the NetBeans Policies and Terms of Use. © 2012, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo