Documentation/Style guide/es

Generalidades
Esta guía de estilo brinda asistencia para la escritura y la edición de documentos técnicos para MediaWiki y otros espacios técnicos. Ofrece sugerencias para ayudarle a escribir documentos técnicos concisos y claros en palabras llanas. Además, le conecta con recursos adicionales sobre escritura técnica y edición en general.

Una buena documentación técnica facilita a las personas a contribuir a los proyectos de Wikimedia. Es importante seguir normas y directrices claras para escribir y editar documentación, sobre todo cuando las y los contribuidores y lectores tienen diferentes niveles de habilidad y experiencia. No importa si se considera redactor/a técnico/a o no. ¡Sus contribuciones son necesarias y apreciadas!

English Wikipedia Manual of Style
The English Wikipedia's Manual of style covers general writing topics (like punctuation) in detail, and summarizes the key points of other style guides. It can be a useful reference for anyone writing or editing technical documentation in English across Wikimedia projects, especially if the local wiki doesn't have more specific guidelines.

This page provides basic guidelines and tips to help get you started with technical documentation. It includes some information specific to technical documentation that is not covered in the Wikipedia Manual of Style.



Audiencia y contenido


Redactar para audiencias técnicas
Before you begin writing, consider the audience for your work:


 * Who will read this technical documentation?
 * Where are they coming from?
 * How familiar are they with the concepts you are presenting?
 * What might they need to know in order to understand?

Once you have an understanding of your audience, you will have a better sense of what you need to communicate.



Redactar con propósito
What purpose will your technical documentation serve? There are many reasons to write documentation. It is helpful to know why you are writing and what your goal is before you begin.


 * Is it to teach someone, like a newcomer, about a process or concept?
 * Is it to show someone how to follow a process?
 * Is it meant to provide background and context for a concept or process?
 * Is it a reference intended to provide information?



Redactar en un contexto
When deciding what to write and how to frame it for your reader, it can help to define a context or occasion for your writing. Your communication takes place in the context of a bigger situation. El contexto puede estar delimitado por la época en la que estás escribiendo, el tipo de tecnología disponible, tu ubicación geográfica y tu cultura, o la cultura actual y los estilos de comunicación de tus lectores. The occasion may be personal and arise from the situation that motivated you to create or improve a piece of documentation.

Por ejemplo, si estás escribiendo documentación técnica para proyectos Wikimedia, ten en consideración la cultura generada por los individuos que participan en esos proyectos. How could you best position your writing within the context of this community and its culture to create the most meaningful and useful technical documentation?

User testing and feedback
Create technical documentation to communicate ideas and concepts to a real audience of users. Naturally, this audience should play a critical role in how the documentation is shaped and reshaped. Think about ways you can gather information about your users' experiences. Take some time to answer the following questions:


 * Does your documentation include a mechanism for feedback?
 * Can you engage in timely conversations with the audience to make improvements?
 * Can you use forums like Stack Overflow or mailing lists to check if your document answers the most common questions people have about your specific topic?



Claridad y coherencia
La claridad y consistencia hace más fácil acceder, leer y crear documentación técnica en los proyectos MediaWiki/Wikimedia. Technical documentation is written for a wide audience and edited by a variety of contributors.

Voice, tone, grammar usage, style, and format should be consistent across technical documentation and similar content collections. This helps readers learn how to navigate information and makes it easier for contributors to understand how to edit and add new information.



Decidir el tipo de documento
Identify your main audience, purpose, and context first to decide on the type of document you will create.

Lenguaje
This section briefly mentions some topics worth exploring elsewhere in more detail. Always check your words and expressions against these criteria on Wiktionary: Wiktionary entries cover hundreds of languages, explicitly state the grammatical and lexical features of words and their declensions, provide detailed context labels (including about jargon, UK vs. USA English) and expose how translatable terms are in hundreds of other languages.



Inglés llano
No se olvide de que muchas de las personas que visitarán estas páginas no serán hablantes de inglés como primera lengua.

For documentation written in English, Plain English (also called plain language) works best. Una redacción clara será la más entendible para audiencias diversas, y también será la más fácil de traducir. There are a number of good tools for checking your writing, at Tech News' Writing Guidelines on Meta-Wiki.



Voz y tono
MediaWiki is a place where anyone can edit. Thus, it can be difficult to maintain a consistent voice and tone in the documentation.

Consider using these elements in your writing:



Punto de vista

 * Use second person ("You" or assumed "You") when addressing your audience.
 * Avoid first person ("I" or "we"), unless you are writing a FAQ with questions asked from the first person perspective.
 * Use an imperative mood for most documentation focused on goals or process.

Fechas

 * Siempre use el año completo, con los cuatro dígitos.
 * Emplee fechas absolutas («en mayo de 2037») en lugar de fechas relativas («el año que viene en mayo»).
 * Avoid adding dates that will require regular manual updates. Example: Write  instead of  when referring to the current year, no matter what year it is currently.



Overview
All pages should include an overview section (also called the Lead section) that explains:


 * 1) Propósito de la página
 * 2) Audiencia de la página
 * 3) Prerequisites the reader will need to know before proceeding (Ex. a working knowledge of Python)
 * 4) Software or tools the reader will need to complete the processes or tasks outlined on the page (Ex. Java installed)
 * 5) Use case, case study, a practical understanding of the product, service or tool in action. (optional)



Sumario

 * Each page should include a table of contents, so information can be accessed easily.

Titles and headers

 * Use sentence case for headers.
 * Keep header fonts consistent throughout documentation.
 * Optional use of anchors to link sections or subsections in the same page.
 * Add a blank line after section headers. This impacts how the content is packaged for translation.
 * Do not put a header before your overview or lead section.

Information flow
Technical documentation pages should follow a consistent pattern across content collections.

An ideal pattern for each page might be:


 * Page title
 * Introduction/Overview
 * Header
 * Content
 * Subhead if needed
 * Content

Formatting code examples and other technical elements
Formatting distinguishes code and other technical elements from regular text.

Templates
Templates are often used on MediaWiki.org pages. Templates can help to maintain consistency and can make it easier to translate information.

Below are some common templates.

Templates for page formatting

 * caution, fixtext, note, tip, todo, warning - for styles of inline highlight boxes
 * fixme, historical, notice, outdated, update - for page/section message boxes
 * main, see also - for page/section hatnotes (a short note placed at the top of an article)

Templates for MediaWiki core and Git source

 * class doclink, file doclink, js doclink - to link to MediaWiki core's generated documentation
 * MW file - for a box with info and links for a file in MediaWiki core
 * git file - to link to source code



Plantillas para Phabricator

 * ptag - for the top-right-of-page Phabricator project tag
 * tracked - for the related Phabricator task



Otras plantillas útiles

 * - for IRC link
 * Key press - for, e.g. Ctrl, and button for, e.g.
 * ApiEx - for api.php request URLs
 * Api help - to transclude generated API documentation
 * RestOfVariableName - for global variables
 * tag - for a quick way to mention an XML-style tag in a preformatted way

Translations
All pages on mediawiki.org are candidates for translation into multiple languages. MediaWiki.org is a multilingual wiki, it uses the Translate extension to present alternative translations and manage the translation of pages.