Los editores en developerWorks esperan trabajar con usted para publicar su contenido. Por favor asegúrese de presentarle su idea a un editor de developerWorks y de obtener su aprobación para proceder con su contenido, antes de utilizar estas instrucciones. Si todavía no lo ha hecho, puede utilizar nuestro formulario de envío de contenido para presentar su idea.
Los artículos y tutoriales se publican en developerWorks en formato HTML, pero se generan desde formato XML (Extensible Markup Language). Su editor developerWorks convertirá sus documentos Microsoft Word y Writer de OpenOffice.org en nuestro formato fuente XML. El éxito de esta conversión a XML depende de qué tanto el documento Word o Writer que usted presente siga las indicaciones de las plantillas que utilizará.
Si usted está familiarizado(a) con el uso de estilos en un procesador de palabras, encontrará nuestras plantillas muy fáciles de usar. Si no lo está, las plantillas contienen instrucciones detalladas sobre cómo aplicar estilos acordes con los consejos de composición y convenciones de resaltado descritas aquí.
¿Plantilla de artículo o plantilla de tutorial?
Si usted ha navegado el sitio developerWorks, sabrá que los autores contribuyen a developerWorks con artículos y con tutoriales. Su formato y propósito difieren. Su editor developerWorks puede ayudarle a decidir qué formato se ajusta más a su idea de contenido.
Tutoriales
- Los tutoriales tienen objetivos educativos, enseñan. En lugar de simplemente listar los pasos, los tutoriales explican por qué se efectúa cada paso y cómo se relaciona con el objetivo general. Los tutoriales expresan los objetivos de aprendizaje y el tiempo de conclusión (normalmente alrededor de dos horas). Después de completar un tutorial, el lector debe poder repetir la tarea aprendida independientemente.
- Los tutoriales pueden enseñar conceptos sobre cómo completar tareas. Muchos tutoriales enseñan conceptos y tareas, y alientan a los lectores a intentar las tareas mientras leen. Para facilitar su seguimiento, los tutoriales a menudo incluyen código de muestra y consejos para configurar el entorno del lector. Frecuentemente los tutoriales también fraccionan contenido en tareas discretas y manejables que constituyen un todo.
- Los tutoriales publicados después del 1º de marzo del 2009, no necesitan registrarse.
- En promedio los tutoriales tienen de 20 a 30 páginas cuando se imprimen. Y como cada tarea puede tomar varias horas para completarse, muchos lectores imprimen el PDF del tutorial para referencia durante, o después de la tarea.
- Un tutorial puede ser independiente o puede ser parte de una serie de múltiples partes.
Artículos
- Como los tutoriales, los artículos a menudo enseñan, pero menos abiertamente que ellos. Los artículos no incluyen sus objetivos educativos ni el tiempo para completarlos.
- Además de instruir a los lectores sobre una tarea en especial, los artículos también pueden presentar nuevos conceptos, arquitecturas o recursos de productos. Este tipo de artículos pretende despertar el interés del lector y avivar su apetito para aprender más (¡tal vez siguiendo un tutorial developerWorks!). Otros tipos de artículos tienen un tono más persuasivo, donde el autor comparte su enfoque, perspectiva o experiencia individual. Y otros tipos de artículos profundizan en un nuevo producto o tecnología, entrevistando a un experto o revisando la literatura existente sobre el tema.
- Los artículos no necesitan ser registrados.
- En promedio los artículos son de 10 páginas o menos cuando se imprimen. Los lectores generalmente leen los artículos en línea.
- Como los tutoriales, los artículos pueden ser independientes o pueden ser parte de una serie de múltiples partes.
Cree un artículo o tutorial siguiendo estos pasos:
- Descargue el paquete de creación para Word o Writer (vea Descargas más adelante) y descomprima el archivo.
- Cree su propia plantilla de artículo o tutorial en Word o Writer, a partir del archivo de plantilla o copiando el artículo o tutorial de muestra.
- Edite su nuevo artículo o tutorial para agregar su contenido, asegurándose de seguir las indicaciones de la plantilla o de la muestra.
- Envíe su artículo o tutorial, junto con cualquier archivo separado, como imágenes o descargas de código, a su editor developerWorks.
Paso 1. Descargue del paquete de creación
Descargue el archivo zip del paquete de creación Word si usted utiliza Word en Windows®, o el zip del paquete de creación
Writer si usted usa Writer en Windows o Linux®. Póngalo en una ubicación apropiada (por ejemplo,
C:\ en Windows o en su directorio de inicio en Linux) y descomprímalo.
Después de descomprimir el archivo, usted deberá ver un directorio (o carpeta) developerWorks conteniendo una sub-carpeta word-templates o writer-templates, dependiendo del paquete que haya descargado.
Los archivos y herramientas incluidos en el paquete de creación están diseñados para usarse en Linux o Windows. Si necesita asistencia para editar las plantillas utilizando un sistema operativo diferente a Windows o Linux, contacte a su editor de developerWorks.
Antes de pasar al Paso 2, veamos primero lo que ha cambiado en este release. Los paquetes de creación versión 5.12 para Word y Writer se publicaron para los autores el 23 de marzo de 2009. Las plantillas en esos paquetes son conformes a la versión 5.12 del esquema y hojas de estilo XML de developerWorks. Usted deberá preparar su artículo o tutorial usando el paquete de creación 5.12 para Word o Writer, según aplique. Si usted está utilizando un release anterior, necesitará descargar el archivo author-package.zip 5.12 de la sección Descargas más abajo.
El release 5.12 de los paquetes de creación de Word y Writer incluye cambios internos para soportar la generación de PDF y micro-sitios developerWorks. Ambos paquetes están sincronizados con la versión 5.12 del esquema y las hojas de estilo developerWorks XML. En otras palabras, cuando su editor developerWorks transforma el XML que usted le envía, el resultado HTML será válido y actualizado. El cambio interno de interés para los autores, como se refleja en las plantillas actualizadas para artículos y tutoriales, es:
- En la sección "Get products and technologies" de Recursos, la viñeta de pruebas de producto IBM incluye texto y código actualizados. Si usted usa la viñeta de pruebas de producto, asegúrese de seleccionar las nuevas plantillas XML o cambie esa viñeta a:
<resource resource-category="Get products and technologies">Download <a href="http://www.ibm.com/developerworks/downloads/" onmouseover="linkQueryAppend(this)">IBM product evaluation versions</a> or <a href="http://www.ibm.com/developerworks/downloads/soasandbox/" onmouseover="linkQueryAppend(this)">explore the online trials in the IBM SOA Sandbox</a> and get your hands on application development tools and middleware products from DB2<reg/>, Lotus<reg/>, Rational<reg/>, Tivoli<reg/>, and WebSphere<reg/>.</resource>
Paso 2. Cree un artículo o tutorial
En este paso, usted configurará su propio artículo o tutorial partiendo de una plantilla o muestra. Las plantillas y muestras contienen cada una ejemplos de la mayoría de los elementos que usted puede utilizar en developerWorks, incluyendo instrucciones para lograr un formato aceptable y los estilos adecuados a aplicar.
- Plantilla
- Si usted tiene experiencia escribiendo para developerWorks, tal vez prefiera comenzar con nuestras plantillas. Cuando usted parte de una plantilla, se le solicitará que complete varios campos con la información developerWorks requerida (vea la Tabla 2 abajo), antes de que se muestre el material instructivo.
- Muestra
- Si usted es principiante escribiendo para developerWorks, le recomendamos que utilice un artículo o tutorial de muestra. Con una muestra, usted puede iniciar con su contenido inmediatamente. La información developerWorks requerida se completa con valores predeterminados, de manera que usted necesitará actualizar los campos antes de enviar su contenido a su editor.
Para crear su propio artículo o tutorial, abra el archivo apropiado listado en la Tabla 1.
| Plantilla o muestra | Programa | Artículo o tutorial | Archivo |
|---|---|---|---|
| Muestra | Word | Artículo | sample-article-word-5.12.doc |
| Tutorial | sample-tutorial-word-5.12.doc | ||
| Writer | Artículo | sample-article-writer-5.12.odt | |
| Tutorial | sample-tutorial-writer-5.12.odt | ||
| Plantilla | Word | Artículo | article-word-5.12.dot |
| Tutorial | tutorial-word-5.12.dot | ||
| Writer | Artículo | article-writer-5.12.ott | |
| Tutorial | tutorial-writer-5.12.ott |
Cuando usted abre una plantilla por primera vez, se le solicitará que complete los campos que se muestran en la Tabla 2. Si no tiene toda la información en ese momento, puede utilizar sin problema los valores predeterminados y actualizarla después.
| Campo | Opcional u obligatorio | Contenido |
|---|---|---|
| Tipo de Presentación | Obligatorio | Artículo o Tutorial. Seleccione del menú desplegable. |
| Título | Obligatorio | Título de su artículo o tutorial. |
| Subtítulo | Opcional | Subtítulo de su artículo o tutorial. Es opcional pero se recomienda. |
| Palabras clave | Opcional | Palabras clave para motores de búsqueda que apliquen a su artículo o tutorial. |
| Prefijo | Opcional | Prefijo para su nombre. Ejemplos: Dr., Sr., o Sra. |
| Nombre | Obligatorio | Su primer nombre. Ejemplo: Juan |
| Segundo nombre | Opcional | Su segundo nombre o la inicial. Ejemplo: D. |
| Apellido | Obligatorio | Su apellido. Ejemplo: Rodríguez |
| Sufijo | Opcional | Sufijo de su nombre. Ejemplos: Jr., o IV |
| Cargo | Obligatorio | Su cargo laboral. Ejemplo: Programador Sénior |
| Obligatorio | Su dirección de e-mail. | |
| Biografía | Obligatoria | Su información biográfica. Incluye su experiencia y las credenciales que le califican para escribir con autoridad sobre este tema. |
| Compañía | Obligatorio | Nombre de su compañía. Ejemplo: IBM |
| Nombre de archivo de su fotografía | Opcional | Nombre de un archivo que contenga una foto suya de cabeza y hombros, apropiada para mostrarla con su información biográfica. |
| Resumen | Obligatorio | Un resumen de su artículo. Incluya los puntos principales y frases clave al comienzo del resumen, ya que se truncará en los resultados de búsqueda. Redacte de tres a cinco frases que expresen por qué el lector debería interesarse por el contenido (motivo) y lo que él o ella puede obtener al leer el contenido (beneficios). |
Guarde su nuevo documento usando un nombre de su elección. Si usted partió de una plantilla, asegúrese de guardarlo como un documento normal (.doc en Word o .odt en Writer) y no como una plantilla.
Paso 3. Edite su artículo o tutorial
Edite su artículo o tutorial siguiendo las indicaciones que hay en nuestros archivos de artículo o tutorial de muestra. Estos le muestran qué estilo aplicar para lograr el formato que dará como resultado una transformación exitosa en developerWorks XML. Es extremadamente importante que usted dé formato a su contenido de acuerdo a estas indicaciones. Si tiene cualquier pregunta, contacte a su editor de developerWorks, para asegurarse de que su contenido no esté comprometido.
Los archivos de muestra (vea la Tabla 1) son su mejor fuente de consejos integrales sobre cómo desarrollar su artículo o tutorial. Los amplios comentarios en las muestras le guían a través de cada aspecto de codificación de su artículo o tutorial. Estos son otros consejos que usted puede hallar útiles:
- Usted puede cortar y pegar desde otros documentos que ya tenga.
Sin embargo, necesitará comparar los estilos que importe con el texto pegado, para asegurarse de que se ajustan a nuestros ejemplos.
- Las muestras incluyen ejemplos de las construcciones utilizadas con mayor frecuencia en artículos y tutoriales developerWorks. Si su contenido no necesita alguna cosa, como una lista o una gráfica, entonces no ponga una sólo porque la muestra la tiene.
- Cuando incluya listados de código de muestra:
- Limite la longitud de las líneas de código a 90 caracteres, INCLUYENDO los espacios en blanco.
- Limite la longitud de los listados de código a 100 líneas, INCLUYENDO las líneas en blanco.
- Evite los espacios en blanco y las etiquetas difíciles de codificar al final de una línea del código de muestra.
- Evite utilizar etiquetas al comienzo de una línea de código de muestra. Si necesita poner sangría, use espacios en blanco.
- No utilice colores. Si desea resaltar alguna parte de su código de muestra, utilice negrita.
- Cuando proporcione código de muestra que se pueda descargar, comprímalo y envíe el archivo zip por separado a su editor.
- Cree todos los archivos de arte, incluyendo capturas de pantalla, como archivos .jpg o .gif, y asegúrese de que no excedan 572 pixeles de ancho (para artículos) ni 500 pixeles (para tutoriales). Envíe los archivos de arte a su editor. Consulte
"Illustrating
your article or tutorial for developerWorks"
para aprender más sobre cómo crear y ofrecer gráficas efectivas.
¿Usted utiliza letra cursiva o comillas para el título de un libro? ¿Cuándo debe usted utilizar negrita—o no utilizar ningún resaltado? La Tabla 2 muestra las convenciones resaltadas recomendadas para artículos y tutoriales developerWorks.
| Elemento resaltado | Resaltado recomendado |
|---|---|
| "Títulos de artículos" | Comillas |
| Títulos de libros | Cursiva |
Código C/C++
| Fuente Courier o Courier New |
Clases
| Fuente Courier o Courier New |
| Muestras de código | Estilo HTML pre-formateado (fuente Courier o Courier New a 8pt) |
Fragmentos de código (menos de una línea) referenciado en texto
| Fuente Courier o Courier New |
| Nombres de columnas o de series | Cursiva |
Nombres de comandos
| Fuente Courier o Courier New |
| Nombres de directorios | Sin resaltar |
| Énfasis | Cursiva. Por ejemplo: "Use eso para introducir una cláusula restrictiva. No sobrescriba..." |
Nombres de excepción
| Fuente Courier o Courier New |
| Nombres de archivos | Sin resaltar |
Llamados de función
| Fuente Courier o Courier New |
| Controles de GUI | Negrita. Por ejemplo: "En el menú Install, haga clic en Install a new feature > Finish." |
Ejemplos de etiquetas o porciones HTML
| Fuente Courier o Courier New |
Interfaces
| Fuente Courier o Courier New |
Palabras clave (como estática)
| Fuente Courier o Courier New |
| Títulos de revistas | Cursiva. Por ejemplo: "Vea el artículo relacionado en LinuxToday." |
Texto de mensajes o prompts dirigidos al usuario
| Fuente Courier o Courier New |
Métodos
| Fuente Courier o Courier New |
Objetos
| Fuente Courier o Courier New |
| Nombres de vías de acceso | Sin resaltar |
| Términos definidos en contexto | Cursiva |
Texto ingresado por los usuarios
| Fuente Courier o Courier New |
| "Títulos de tutorial" | Comillas |
Tipos (como int o long)
| Fuente Courier o Courier New |
| URLs | Sin resaltar |
| Variables | Cursiva. Por ejemplo: "... donde myname representa su ID de usuario..." |
Etiquetas o porciones XML
| Fuente Courier o Courier New |
Paso 4. Envíe su artículo o tutorial a developerWorks
En cuanto haya completado su contenido, estará listo para enviarlo a su editor developerWorks. Envíe por e-mail a su editor el archivo Word o Writer de su artículo o tutorial (junto con cualquier gráfica o código de muestra asociado). Para indicaciones detalladas y consejos sobre la creación y presentación de gráficas para su artículo, vea "Illustrating your article or tutorial for developerWorks."
Si tiene problemas o preguntas, contacte a su editor para ayuda adicional.
| Descripción | Nombre | tamaño | Metodo de descarga |
|---|---|---|---|
| IBM developerWorks author package - Word, V5.12 | author-package-word-V5.12_20090320.zip | 251KB | HTTP |
| IBM developerWorks author package - Writer, V5.12 | author-package-writer-V5.12_20090320.zip | 397KB | HTTP |
Información sobre métodos de descarga
Aprender
-
"Authoring with the
developerWorks XML templates"
(developerWorks, marzo de 2009): Si en lugar de utilizar Word o Writer usted prefiere escribir su contenido usando nuestras plantillas XML, encuentre las instrucciones completas y las plantillas en este paquete descargable para autores.
-
"Illustrating your
article or tutorial for developerWorks: How to create effective graphics
"
(developerWorks, julio de 2008): Obtenga indicaciones detalladas y consejos sobre la creación y presentación de gráficas para su artículo o tutorial.
-
Indicaciones para autores developerWorks y política editorial:
Aprenda más acerca de nuestra política editorial y dé un vistazo a la lista de deseos de contenido de cada editor de developerWorks.
Obtener los productos y tecnologías
-
Productos de prueba IBM para descargar:
Desarrolle su próximo proyecto de desarrollo con software de prueba IBM, disponible para descarga directamente desde developerWorks.
Comentar
-
Formulario de envío de contenido:
Presente una idea de artículo o de tutorial a developerWorks y comience a hablar con un editor developerWorks. Consulte cuál contenido es el más deseado, en la
lista de deseos de contenido.
-
Información de contacto de editor developerWorks:
Si tiene preguntas, contacte al editor de la tecnología o zona de producto con que se relaciona su contenido.
Ian Shields trabaja en múltiples proyectos Linux para la zona Linux de developerWorks. Es Senior Programmer de IBM en el Research Triangle Park (RTP), Carolina del Norte. Ingresó a IBM en Canberra, Australia, como Systems Engineer en 1973, y desde entonces se dedica a sistemas de comunicaciones y computación ubicua en Montreal, Canadá, y en el RTP de Carolina del Norte. Es propietario de numerosas patentes y publicó diversos trabajos. Tiene una diplomatura en Matemática Pura y Filosofía de la Universidad Nacional de Australia. Es Máster y Doctor en Ciencias de la Computación de la Universidad Estatal de Carolina del Norte. Para contactar a Ian, escríbale a: ishields@us.ibm.com.