Руководство по стилю документов

From Wikipedia, the free encyclopedia

A style guide, or style manual, is a set of standards for the writing and design of documents, either for general use or for a specific publication, organization or field. The implementation of a style guide provides uniformity in style and formatting within a document and across multiple documents. A set of standards for a specific organization is often known as «house style». Style guides are common for general and specialized use, for the general reading and writing audience, and for students and scholars of various academic disciplines, medicine, journalism, the law, government, business, and industry.

International[edit]

Several basic style guides for technical and scientific communication have been defined by international standards organizations. These are often used as elements of and refined in more specialized style guides that are specific to a subject, region, or organization. Some examples are:

  • EN 15038, Annex D – European Standard for Translation Services (withdrawn)
  • ISO 8 – Presentation of periodicals
  • ISO 18 – Contents lists of periodicals
  • ISO 31 – Quantities & units
  • ISO 214 – Abstracts for publication & documentation
  • ISO 215 – Presentation of contributions to periodicals and other serials[1]
  • ISO 690 – Bibliographic references – Content, form & structure
  • ISO 832 – Bibliographic references – Abbreviations of typical words
  • ISO 999 – Index of a publication
  • ISO 1086 – Title leaves of a book
  • ISO 2145 – Numbering of divisions & subdivisions in written documents
  • ISO 5966 – Presentation of scientific & technical reports (withdrawn)
  • ISO 6357 – Spine titles on books & other publications
  • ISO 7144 – Presentation of theses & similar documents
  • ISO 9241 – Ergonomics of Human System Interaction
  • ISO 17100 – Translation Services-Requirements for Translation Services

Australia[edit]

General[edit]

  • Australian Government Style Manual by Digital Transformation Agency. 7th ed.
  • Style Manual: For Authors, Editors and Printers by Snooks & Co for the Department of Finance and Administration. 6th ed. ISBN 0-7016-3648-3.
  • The Australian Handbook for Writers and Editors by Margaret McKenzie. 4th ed. ISBN 9781921606496.
  • The Cambridge Guide to Australian English Usage by Pam Peters of Macquarie University. 2nd ed. ISBN 9780521702423.
  • The Complete Guide to English Usage for Australian Students by Margaret Ramsay. 6th ed. ISBN 9780521702423.

Law[edit]

  • Australian Guide to Legal Citation published by University of Melbourne Law School. 4th ed. ISBN 9780521702423.

Science[edit]

  • Australian manual of scientific style (AMOSS) by Biotext; illustrated by Biotext. 1st ed. ISBN 978-0-9946369-0-4

Canada[edit]

  • The Canadian Style: A Guide to Writing and Editing: by Dundurn Press in co-operation with Public Works and the Government Services Canada Translation Bureau. ISBN 1-55002-276-8.

Newspapers[edit]

  • CP Stylebook: Guide to newspaper style in Canada maintained by the Canadian Press. ISBN 0-920009-38-7.
  • The Globe and Mail Style Book: Originally created to help writers and editors at the Globe and Mail present clear, accurate and concise stories. ISBN 0-7710-5685-0

European Union[edit]

  • Interinstitutional Style Guide.[2]
  • English Style Guide («A handbook for authors and translators in the European Commission» – executive branch of the European Union.)[3]

United Kingdom[edit]

General[edit]

  • Copy-editing: The Cambridge Handbook for Editors, Authors and Publishers Judith Butcher. 3rd ed. 1992 Cambridge: Cambridge University Press ISBN 0-521-40074-0
  • Fowler’s Modern English Usage. Ed. R. W. Burchfield. Rev. 3rd ed. London: Clarendon Press, 2004. ISBN 0-19-861021-1 (hardcover). Based on Modern English Usage, by Henry Watson Fowler.
  • The King’s English, by Henry Watson Fowler and Francis George Fowler.
  • The Oxford Style Manual (2003 ed.). Combines The Oxford Guide to Style and The Oxford Dictionary for Writers and Editors, which concentrates on common problems.
  • The Complete Plain Words, by Sir Ernest Gowers.
  • Usage and Abusage, by Eric Partridge.

For legal documents[edit]

  • Oxford Standard for Citation of Legal Authorities (OSCOLA), by the University of Oxford Faculty of Law

For journalism[edit]

  • The BBC News Style Guide: by the British Broadcasting Corporation.[4]
  • The Economist Style Guide: by The Economist.[5]
  • The Guardian Style Guide: by The Guardian[6]
  • The Times Style and Usage Guide, by The Times.

For the computer industry (software and hardware)[edit]

  • Acorn Technical Publications Style Guide, by Acorn Computers. Provides editorial guidelines for text in RISC OS instructional publications, technical documentation, and reference information.[7]
  • RISC OS Style Guide[8] by RISC OS Open Limited. Provides design guidelines, help and dialogue box phrasing examples for the software user interface.

United States[edit]

In the United States, most journalistic forms of mass communication rely on styles provided in the Associated Press Stylebook (AP). Corporate publications typically follow either the AP style guide or the equally respected Chicago Manual of Style, often with entries that are additions or exceptions to the chosen style guide.

A classic grammar style guide is The Elements of Style. Together, these two books are referenced more than any other general style book for US third-person writing used across most professions.[citation needed]

For general writing[edit]

  • The Careful Writer, by Theodore Bernstein.
  • Bryson’s Dictionary of Troublesome Words: A Writer’s Guide to Getting It Right, by Bill Bryson.
  • Garner’s Modern American Usage by Bryan A. Garner.
  • The Associated Press Stylebook Basic Books ISBN 978-0-917360-63-3.
  • The Elements of Style. By William Strunk, Jr. and E. B. White. (Often referred to as «Strunk and White».)

For legal documents[edit]

  • The Bluebook: A Uniform System of Citation. Jointly, by the Harvard Law Review, Yale Law Journal, Columbia Law Review, and Penn Law Review.
  • The Indigo Book: An Open and Compatible Implementation of A Uniform System of Citation. Collaboratively by Professor Christopher Jon Sprigman and NYU law students, and published by Public.Resource.Org.
  • ALWD Guide to Legal Citation, formerly ALWD Citation Manual, by the Association of Legal Writing Directors
  • New York Style Manual: The Tanbook, by the New York State Reporter

For academic papers[edit]

  • The Chicago Manual of Style, Chicago: University of Chicago Press.
  • A Manual for Writers of Research Papers, Theses, and Dissertations, Chicago Style for Students and Researchers, by Kate L. Turabian. Often referred to as «Turabian.»
  • MLA Handbook for Writers of Research Papers, by Joseph Gibaldi. Often referred to as «MLA».
  • Publication Manual of the American Psychological Association, by the American Psychological Association (APA).

For journalism[edit]

  • The Associated Press Stylebook Basic Books ISBN 978-0-917360-63-3.
  • The New York Times Manual of Style and Usage. By Allan M. Siegal and William G. Connolly.
  • The Wall Street Journal Guide to Business Style and Usage, by Ronald J. Alsop and the Staff of the Wall Street Journal.
  • The BuzzFeed Style Guide: by Emmy Favilla and Megan Paolone.[9]

For electronic publishing[edit]

  • The Columbia Guide to Online Style, by Janice Walker and Todd Taylor.
  • Web Style Guide: Basic Design Principles for Creating Web Sites, by Patrick J. Lynch and Sarah Horton.
  • The Associated Press Stylebook, By the Associated Press, Basic Books ISBN 978-0-917360-63-3.

For business[edit]

  • The Associated Press Stylebook Basic Books ISBN 978-0-917360-63-3.
  • The Business Style Handbook, An A-to-Z Guide for Effective Writing on the Job, by Helen Cunningham and Brenda Greene.[10]
  • The Gregg Reference Manual, by William A. Sabin.

For the computer industry (software and hardware)[edit]

  • Apple Style Guide, published online by Apple Inc.[11] Provides editorial guidelines for text in Apple instructional publications, technical documentation, reference information, training programs, and the software user interface.
    An earlier version was the Apple Publications Style Guide.[12][13]
  • DigitalOcean documentation style guide, published online by DigitalOcean.[14]
  • GNOME documentation style guide, published online by GNOME.[15]
  • Google Developer Documentation Style Guide, published online by Google.[16] Provides a set of editorial guidelines for anyone writing developer documentation for Google-related projects.
  • Mailchimp content style guide, published online by Mailchimp.[17]
  • Microsoft Writing Style Guide, published online by Microsoft Corporation.[18] Provides a style standard for technical documentation including use of terminology, conventions, procedure, design treatments, and punctuation and grammar usage. Before 2018, Microsoft published a book, the Microsoft Manual of Style for Technical Publications.
  • MongoDB documentation style guide, published by MongoDB.[19]
  • Mozilla Writing Style Guide, published online by Mozilla.[20]
  • Rackspace style guide for technical content, published online by Rackspace.[21]
  • Read Me First! A Style Guide for the Computer Industry, by Sun Technical Publications, 3rd ed., 2010.[22]
  • Red Hat style guide for technical documentation, published online by Red Hat.[23]
  • Salesforce style guide for documentation and user interface text, published online by Salesforce.[24]
  • SUSE documentation style guide, published online by SUSE.[25]
  • The IBM Style Guide: Conventions for Writers and Editors, 2011,[26] and Developing Quality Technical Information: A Handbook for Writers and Editors, 2014,[27] from IBM Press.
  • The Splunk Style Guide, published online by Splunk.[28] Provides a writing style reference for anyone writing or editing technical documentation.
  • The Yahoo! Style Guide, 2010.[29]

Editorial style guides on preparing a manuscript for publication[edit]

  • The Associated Press Stylebook Basic Books ISBN 978-0-917360-63-3.
  • The Chicago Manual of Style, by University of Chicago Press staff.
  • Words into Type, by Marjorie E. Skillin, Roberta

Academic[edit]

  • The Chicago Manual of Style. The standard of the academic publishing industry including many journal publications.
  • A Manual for Writers of Term Papers, Theses, and Dissertations (frequently called «Turabian style»)—Published by Kate L. Turabian, the graduate school dissertation secretary at the University of Chicago from 1930 to 1958. The school required her approval for every master’s thesis and doctoral dissertation. Her stylistic rules closely follow The Chicago Manual of Style, although there are some differences.
  • ACS Style Guide—for scientific papers published in journals of the American Chemical Society.
  • American Medical Association Manual of Style—for medical papers published in journals of the American Medical Association.
  • American Psychological Association Style Guide—for the behavioral and social sciences; published by the American Psychological Association.
  • American Sociological Association Style Guide—for the social sciences; published by the American Sociological Association.
  • Geoscience Reporting Guidelines—for geoscience reports in industry, academia and other disciplines.[30]
  • Handbook of Technical Writing, by Gerald J. Alred, Charles T. Brusaw, and Walter E. Oliu.—for general technical writing.
  • IEEE style—used in many technical research papers, especially those relating to computer science.
  • The Little Style Guide by Leonard G. Goss and Carolyn Stanford Goss—provides a distinctively religious examination of style and language for writers and editors in religion, philosophy of religion, and theology—ISBN 978-0-8054-2787-5.
  • MHRA Style Guide—for the arts and humanities; published by the Modern Humanities Research Association. Available as a free download (see article).
  • MLA Style Manual, and the MLA Handbook for Writers of Research Papers—for subjects in the arts and the humanities; published by the Modern Language Association of America (MLA).
  • SBL Handbook of Style—Society of Biblical Literature style manual specifically for the field of ancient Near Eastern, biblical, and early Christian studies. The SBL Handbook of Style includes a recommended standard format for abbreviation of Primary Sources in Ancient Near Eastern, biblical, and early Christian Studies.
  • Scientific Style and Format: The CSE Manual for Authors, Editors, and Publishers—for scientific papers published by the Council of Science Editors (CSE), a group formerly known as the Council of Biology Editors (CBE).[31]
  • The Style Manual for Political Science—used by many American political science journals; published by the American Political Science Association.

Communities[edit]

  • GLAAD Media Reference Guide, 8th ed., GLAAD College Media Reference Guide, 1st ed., GLAAD Chinese Media Reference Guide, 1st ed. — published by GLAAD to encourage media outlets to use language and practices inclusive of LGBT people. Available as a free download.[32]
  • Conscious Style Guide[33] — A website «devoted to conscious language. My mission is to help writers and editors think critically about using language—including words, portrayals, framing, and representation—to empower instead of limit.» Created by author and Robinson Prize winner Karen Yin.

Art[edit]

  • Association of Art Editors Style Guide[34]

See also[edit]

  • Citation
  • Diction
  • Documentation
  • Disputed usage
  • English writing style
  • Grammar
  • Prescription and description
  • Punctuation
  • Sentence spacing in language and style guides
  • Spelling
  • Style guide
  • Stylistics

References[edit]

  1. ^ «ISO 215:1986 — Documentation — Presentation of contributions to periodicals and other serials». Iso.org.
  2. ^ «Publications Office — Interinstitutional style guide — Home». Publications.europa.eu.
  3. ^ «English resources: English Style Guide». European Commission. Archived from the original on December 22, 2016.|date=April 2023}}
  4. ^ «BBC News style guide». BBC Academy.
  5. ^
    «Style Guide | the Economist». The Economist. Archived from the original on 2013-02-07. Retrieved 2017-01-05.
  6. ^ «Guardian and Observer style guide: A». Theguardian.com. 23 December 2015.
  7. ^ «Acorn Publications Open Style Guide» (PDF). RISC OS Open. Retrieved 30 April 2021.
  8. ^ «RISC OS Open: Style Guide». RISC OS Open.
  9. ^ Paolone, Emmy Favilla, Megan. «BuzzFeed Style Guide». BuzzFeed.com.{{cite web}}: CS1 maint: multiple names: authors list (link)
  10. ^ Library of Congress Catalog Record for The Business Style Handbook. 2013. ISBN 9780071800105.
  11. ^ Apple Inc. (July 2020). «Apple Style Guide».
  12. ^ (PDF). 17 February 2015 https://web.archive.org/web/20150217214323/https://help.apple.com/asg/mac/2013/ASG_2013.pdf. Archived from the original (PDF) on 17 February 2015.
  13. ^ «Archived copy». Archived from the original on 2013-09-29. Retrieved 2013-09-25.{{cite web}}: CS1 maint: archived copy as title (link)
  14. ^ Digital Ocean. «DigitalOcean documentation style guide».
  15. ^ GNOME. «GNOME documentation style guide».
  16. ^ Google LLC. «Google developer documentation style guide».
  17. ^ Mailchimp. «Mailchimp content style guide».
  18. ^ Microsoft. «Microsoft Writing Style Guide».
  19. ^ MongoDB. «MongoDB documentation style guide».
  20. ^ Mozilla. «Mozilla Writing Style Guide».
  21. ^ Rackspace. «Rackspace style guide for technical content».
  22. ^ Sun Technical Publications (2010). Read me first!: a style guide for the computer industry, 3rd ed. Prentice Hall. ISBN 9780137058266.
  23. ^ Red Hat. «Red Hat Style Guide».
  24. ^ Salesforce. «Salesforce style guide for documentation and user interface text».
  25. ^ SUSE. «SUSE documentation style guide».
  26. ^ DeRespinis, Francis (2011). The IBM Style Guide: Conventions for Writers and Editors. IBM Press. ISBN 9780132101301.
  27. ^ Carey, Michelle (2014). Developing Quality Technical Information: A Handbook for Writers and Editors, 3rd ed. IBM Press. ISBN 9780133119008.
  28. ^ «Welcome to the Splunk Style Guide — Splunk Documentation». docs.splunk.com. Retrieved 2019-12-03.
  29. ^ Barr, Chris (2010). The Yahoo! Style Guide. Yahoo! Inc. ISBN 9780312569846.
  30. ^ «Shaw Communications». Members.shaw.ca.
  31. ^ «Scientific Style and Format Online». Scientific Style and Format Online.
  32. ^ «GLAAD Media Reference Guide — 10th Edition». Glaad.org. 25 August 2011.
  33. ^ Yin, Karen. «Conscious Language + Design». Conscious Style Guide. Retrieved 2023-09-02.
  34. ^ «AAE Style Guide NEW». 7 March 2015. Archived from the original on 7 March 2015.

External links[edit]

From Wikipedia, the free encyclopedia

This article is about guides for writing. For style guides as fashion guides, often issued within fashion magazines, see List of fashion magazines.

A style guide is a set of standards for the writing, formatting, and design of documents. A book-length style guide is often called a style manual or manual of style (MoS or MOS). (Typical examples include the Chicago Manual of Style and the AMA Manual of Style.) A short style guide, of several pages or several dozen pages, is often called a style sheet, although that term also has multiple other meanings. The standards documented in a style guide can be applied either for general use, or be required usage for an individual publication, a particular organization, or a specific field.

A style guide establishes standard style requirements to improve communication by ensuring consistency both within a document, and across multiple documents. Because practices vary, a style guide may set out standards to be used in areas such as punctuation, capitalization, citing sources, formatting of numbers and dates, table appearance and other areas. The style guide may require certain best practices in writing style, usage, language composition, visual composition, orthography, and typography. For academic and technical documents, a guide may also enforce the best practice in ethics (such as authorship, research ethics, and disclosure) and compliance (technical and regulatory). For translations, a style guide may be used to enforce consistent grammar choices such as tenses, formality levels in tones, and localization decisions such as units of measurements.

Style guides are specialized in a variety of ways, from the general use of a broad public audience, to a wide variety of specialized uses, such as for students and scholars of various academic disciplines, medicine, journalism, the law, government, business in general, and specific industries. The term house style refers to the styling defined by the style guide of a particular publisher or other organization.

Varieties[edit]

Style guides vary widely in scope and size, and writers working in most large industries or professional sectors reference a specific style guide, written for their industry or sector when writing very specialized document types. These guides are, for the most part, only relevant and useful for peer-to-peer specialist documentation or to help writers working in specific industries and/or sectors communicate highly technical information in scholarly articles or industry white papers.

Professional reference style guides from different countries give authoritative advice on their language and how to use it, such as the New Oxford Style Manual from Oxford University Press, UK and The Chicago Manual of Style from the University of Chicago Press, US; Australia and Canada both have style guides created by their governments which are available online.

Sizes[edit]

This variety in scope and length is enabled by the cascading of one style over another, in a way analogous to how styles cascade in web development and in desktop cascade over CSS styles.

A short style guide is often called a style sheet. A comprehensive guide tends to be long and is often called a style manual or manual of style (MOS or MoS). In many cases, a project such as one book, journal, or monograph series typically has a short style sheet that cascades over the somewhat larger style guide of an organization such as a publishing company, whose content is usually called house style. Most house styles, in turn, cascade over an industry-wide or profession-wide style manual that is even more comprehensive. Some examples of these industry style guides include the following:

  • ACS style, AMA style, and CSE style for various hard sciences
  • AP Stylebook for journalism and all types of internal and external corporate communications
  • APA style and ASA style for the social sciences
  • Bluebook style for law
  • The Chicago Manual of Style (CMOS) and Oxford style for academic writing and publishing
  • MLA style for language and literature studies, and normatively in American secondary education
  • USGPO style and AGPS style for government publications

Finally, these reference works cascade over the orthographic norms of the language in use (for example, English orthography for English-language publications). This, of course, may be subject to national variety, such as the different varieties of British English, American English, Canadian English and Australian English.

Topics[edit]

Some style guides focus on specific topic areas such as graphic design, including typography. Website style guides cover a publication’s visual and technical aspects along with text.

Style guides that cover usage may suggest ways of describing people that avoid racism, sexism, and homophobia. Guides in specific scientific and technical fields cover nomenclature, which specifies names or classifying labels that are preferred because they are clear, standardized, and ontologically sound (e.g., taxonomy, chemical nomenclature, and gene nomenclature).

Updating[edit]

Most style guides are revised from time to time to accommodate changes in conventions and usage. The frequency of updating and the revision control are determined by the subject. For style manuals in reference work format, new editions typically appear every 1 to 20 years. For example, the AP Stylebook is revised annually, and, as of 2021, the Chicago, APA, and ASA manuals are in their 17th, 7th, and 4th editions, respectively. Many house styles and individual project styles change more frequently, especially for new projects.

See also[edit]

  • Citation style
  • Graphic charter
  • Diction
  • Documentation
  • Disputed usage
  • English writing style
  • List of style guides
  • Prescription and description
  • Sentence spacing in language and style guides
  • Spelling
  • Style sheet (disambiguation)

References[edit]

External links[edit]

  • But the stylebook says … – Blog post about stylebook abuse, by Bill Walsh of The Washington Post
  • Handouts about writing style guides, from a conference of the American Copy Editors Society in 2007
    • William G. Connolly. «How to Write a Stylebook in 10 Easy Steps» (PDF). Archived from the original (PDF) on 21 August 2010.
    • Doug Kouma. «Creating an In-House Stylebook» (PDF). Meredith Special Interest Media. Archived from the original (PDF) on 21 August 2010.
  • Language Log » Searching 43 stylebooks

Дисклеймер: это продолжение темы о составлении правильной технической документации. В первой статье мы рассказали, какие цели преследуются при составлении инфраструктурной документации и какие у нее особенности. А теперь поговорим о том, как составить годный стайлгайд, чтобы документы были удобочитаемыми, консистентными и… может быть, даже красивыми :-)

Что такое стайлгайд?

Дословный перевод английского словосочетания Style guide — «руководство по стилю». Применительно к документации это набор правил и требований, включающий особенности стиля и тона изложения, оформления текста и структуры, использования терминологии и т.д.

Стайлгайд обеспечивает консистентность текста, ускоряет адаптацию новых сотрудников и экономит время, сводя к минимуму дискуссии о том, как правильно писать или оформлять текст.

В англоязычном сегменте интернета легко найти стайлгайды разных компаний: например, Google, Mailchimp, Veeam. Они буквально-таки всеобъемлющие. Но годятся только для английского языка. А как быть с русским?

Как таковых «стайлгайдов» для великого и могучего нет. Но есть ГОСТы, из которых можно почерпнуть информацию о структуре и содержании тех или иных технических документов; есть “Справочник издателя и автора”, который дает наиболее полную информацию о правилах оформления документов; наконец, есть справочник Д. Э. Розенталя с правилами правописания.

Все они являются фундаментальными источниками, однако было бы слишком трудозатратно каждый раз лазить в них и искать очередной ответ на вопрос «как правильно?» Так что проще один раз сильно напрячься и составить свой стайлгайд, который будет опираться на эти источники и содержать наши локальные правила.

Стайлгайд: начало

Мы разделили стайлгайд на три основных части. Или на три документа:

  • стайлгайд документации в вики-системе;
  • стайлгайд составления схем;
  • стайлгайд документации для клиентов.

Различия правил документации в вики-системе и документации, которая передаётся клиентам, обусловлены по большей части, используемым инструментарием. У нас вики-система Confluence, и у клиентов нет к ней доступа. Им мы передаем документацию в формате офисных документов или переносим в их базу знаний. По этой причине и существуют определенные различия в структуре и оформлении документов.

Вначале мы выделили основные вопросы, которые возникают у технического писателя при создании документации:
Как мы пишем те или иные термины? Например, мы пишем «кубернетес» или «Kubernetes»? Или «k8s»?
Ответ на такой вопрос должен давать глоссарий. И значит он нам нужен.

В каком порядке располагаем статьи и как заполняем шаблоны? Какой структуры придерживаемся?
Нужны правила структуры по пространствам, разделам, подразделам и статьям.

Как мы пишем? Подробно или кратко? Какой стиль написания используем?
Нужно сформулировать хотя бы несколько основных правил.

А каким языком? Например, насколько допустимо использование профессионализмов, сокращений, канцеляризмов и т.п?
Нужны конкретные правила их использования в документации. А также любые другие правила по написанию, которые помогут привести документацию к единому виду.

Как мы оформляем документацию? Какие используем шрифты, цвета? Как оформляем списки и заголовки? Какие элементы и макросы используем и для чего? Какие правила использования жирного и курсива, кавычек, таблиц, изображений, видео и т.д.
Нужны правила оформления.

Как привести схемы к единому виду? Какие есть общие правила при их составлении? Что нужно отобразить на схеме, какие отношения и связи? Какие типы схем мы составляем?
Нужно сделать унификацию элементов схемы, записать правила использования цветов, шрифтов и размеров, составить библиотеки используемых элементов и привести примеры правильных схем, в которых наиболее полно используются элементы и показаны связи между ними.

В глоссарий мы записали самые распространенные термины, с которыми возникала путаница, и оформили его в виде таблицы:

Её предполагается заполнять и дальше — каждый может добавить термин, которому нужно дать понятное определение и правильное обозначение в документации.

Основной стайлгайд включает в себя следующие разделы:

Во введении мы дали небольшое определение для стайлгайда и указали, для каких пространств мы применяем его правила.

Целевая аудитория — это краткий портрет пользователей, для которых пишется документация. Он позволяет правильно сформулировать правила написания и язык статей.

Раздел с оформлением статей включает в себя такие правила, как:

  • обязательное использование макроса оглавления;
  • использование заголовков: определили, что для структуры наших статей будет достаточно заголовков 2-го и 3-го уровней — использование заголовков ниже третьего уровня будет только усложнять структуру;
  • использование для кода и файлов конфигурации макроса — «блок кода»;
  • использование макросов выделения. Например, в каких случаях использовать макрос «информация», а в каких «предупреждение»;
  • использование макроса «раскрыть» для длинных списков. Особенность нашей документации в том, что там часто используются списки и они могут существенно удлинять статью. Поэтому если в списке более 10 пунктов, то такой список желательно сделать раскрывающимся;
  • использование макроса drawio для схем. Так как схемы требуется постоянно обновлять, то удобнее, когда в документации они располагаются не в виде картинки, а внутри макроса. Это позволяет быстро и просто вносить в схему нужные изменения;
  • использование дефисов и тире, жирного и курсива;
  • подписи к картинкам и скриншотам — в каких случаях они нужны, а когда их можно опускать;
  • использование маркированных и нумерованных списков — в чем разница, когда и какой нужно использовать. Также правила их оформления — пункты маркированных списков начинаются с маленькой буквы и заканчиваются точкой с запятой, пункты нумерованных списков начинаются с заглавной буквы и заканчиваются точкой;
  • использование макросов для добавления ссылок и таблиц.

В описание структуры разделов и статей мы включили сначала общие правила структурирования: нужно ли располагать информацию в родительских статьях, когда статьи нужно объединять в один подраздел, как менять порядок страниц.

Далее мы определили частные правила для некоторых пространств в Confluence. Например, для большого раздела, в котором находится документация по клиентским проектам: так как это основной раздел, с которым работают тех.писатели, то правила его структуры мы описали наиболее подробно.

Например, мы определили четыре основных возможных варианта структуры клиентского проекта:

  • простой;
  • стандартный;
  • расширенный 1;
  • расширенный 2.

Для наглядного представления структуры была составлена майндмапа, в которой расписан каждый из 4-х вариантов структуры:

На примере стандартного варианта (самого распространенного) описали предназначение каждой статьи. Также добавили указание на использование шаблонов для статей, если таковые наличествуют, и инструкцию по их заполнению.

В разделе Расстановка тегов — правила, по которым нужно добавлять теги: обязательные теги, типы тегов для инструкций, теги при наличии алертов и т.д.

При этом правила тегов для пространства с документацией по клиентским проектам и остальными разделами несколько различаются. Эти различия также добавлены в стайлгайд.

В последнем разделе основного стайлгайда — язык статей. Мы указали все основные правила, которых нужно придерживаться при написании статей документации:

  • длинные предложения лучше разбивать на короткие;
  • названия статей желательно делать короткими и лаконичными;
  • избегаем слов и предложений без конкретной смысловой нагрузки;
  • статьи пишем не сплошным текстом, а разбиваем на разделы и подразделы;
  • инструкции пишем в повелительном наклонении — «сделайте», «добавьте» и т.д.;
  • термины указываем согласно глоссарию;
  • стараемся не использовать: канцеляризмы, профессионализмы и жаргонизмы, сложные и длинные предложения с причастиями и деепричастиями, пассивный залог, вводные конструкции («на мой взгляд», «кстати» и т.п.), оценки и усилители («эффективный», «идеальный» и т.п.), а также слова, создающие неопределенность, повторы и тавтологию в тексте.

Правила оформления схем мы вынесли в отдельный стайлгайд:

Введение описывает, какие типы схем мы составляем и для чего применяется этот стайлгайд.

В общих правилах оформления мы указали:

  • какие использовать шрифты, размеры текста, цвета самого текста и его фона. При этом отдельно расписали их для элементов сервера, текста указателей и текста доп.описаний;
  • оформление блоков элементов — какие использовать фигуры и палитру цветов, нужно ли использовать скругление и градиент, насыщенность элементов заднего плана;
  • правила загрузки сторонних и больших изображений;
  • единый размер элементов сервисов;
  • варианты группировки серверов, подсетей;
  • варианты изображения подключений и репликаций;
  • варианты группировки элементов и сервисов.

В правилах оформления элементов облачных сервисов описано:

  • использование иконок, соответствующих сервису, из готовых библиотек облаков;
  • сохранение пропорций и стандартных цветов иконок.

Также мы добавили примеры для схем облачных сервисов.

В остальном стайлгайд схем находится в стадии активной разработки. Планируется добавить больше примеров разных типов схем, внести их описание и предназначение, а также составить собственную библиотеку готовых элементов, которые мы часто используем.

Правила оформления для документации, которая передается клиентам, мы также оформили в отдельный документ со следующим содержанием:

Разделы Введение и Язык написания полностью дублируют основной стайлгайд — здесь правила едины как для статей в вики-системе, так и для офисных документов. Эти разделы скопированы сюда только для удобства — чтобы все правила для определенных документов были в одном месте.

В одноименном разделе мы определили основные типы документов, которые мы передаем нашим клиентам на текущий момент:

  • приёмо-сдаточная документация;
  • отчет по нагрузочному тестированию;
  • отчет по аудиту Kubernetes.

В разделе оформление документов мы подробно описали следующие правила:

  • какие мы используем шрифты;
  • размеры основного текста и заголовков;
  • используемую цветовую гамму;
  • размеры полей, используемое выравнивание;
  • отступы и междустрочные интервалы;
  • использование нумерации, рисунков и подписей к ним;
  • использование таблиц и подписей к ним;
  • обязательное содержание документов — титульный лист, оглавление, основная часть, заключение;
  • использование дефисов и тире;
  • использование маркированных и нумерованных списков;
  • использование логотипа ITSumma.

На этом основной этап создания стайлгайда завершен. Главных доработок требует только стайлгайд для схем.

Какие проблемы решило наличие стайлгайда

Попробую теперь сформулировать, какие именно проблемы мы решили при помощи стайлгайда:

  1. Приведение документации к единому виду. Это помогает быстрее и проще ориентироваться по документации.
  2. Сокращение времени на адаптацию нового сотрудника в отделе документирования. Теперь не нужно передавать знания из уст в уста, всё хранится в одном месте.
  3. Сокращение времени на подготовку документов для клиентов. То есть ускорение оказания услуг нашим заказчикам.
  4. Формализация знаний, которые ранее хранились в головах разных людей.

Плюс во время составления стайлгайда родились и другие идеи по улучшению и упрощению работы тех.писателей. Мы поняли, каких инструкций нам не хватает, и некоторые даже написали, структурировали свои знания и организовали собственную базу знаний. Это улучшило взаимодействие между тех.писателями.

Какие вопросы остаются

Самый основной вопрос и сложность — как привести всю документацию в соответствие со стайлгайдом и как это соответствие поддерживать…

Приводить документацию к новому виду мы начали с раздела клиентской документации. Но и это делается не по принципу «ну-ка навались», а постепенно, так как процесс этот довольно трудозатратный. Постоянно нужно вносить правки, добавлять документацию к новым проектам, править схемы и т.д. Поэтому приведение документации к новому виду разбивается на подзадачи по проектам и выполняется как второстепенная задача.

Но даже если бы было возможно разом привести документацию к красивому и правильному виду, то остается вопрос, как ее поддерживать в таком виде.

Пока самым логичным решением видится добавление обязательного этапа ревью. Он будет включать не проверку технических вопросов и смыслового содержания статей, а соответствие букве закона стайлгайдам. Ревью можно сделать перекрестным — это, во-первых, улучшит качество статей и повысит соответствие принятым правилам, а во-вторых, доведёт следование правилам до автоматизма на эти правила — все выучат их назубок и будут быстро находить и исправлять несоответствия.

Что дальше?

Стайлгайд наш не отлит в граните: он может и должен изменяться, дополняться и улучшаться. Поэтому было бы здорово через некоторое время вновь осмыслить глобально, что из введенных правил актуально, а чем так и не стали пользоваться. Например, потому что всем проще и привычнее делать вот так, а не так как написано.

Если эта статья станет для вас импульсом к созданию собственного стайлгайда (на что я надеюсь :-) ), пишите в комментариях вопросы — на все отвечу, чем смогу — помогу.

Собственное руководство по стилю Википедии см. Википедия: Руководство по стилю.

Руководства по стилю

OED2 volumes.jpg
  • Руководство по стилю ACS
  • Руководство по стилю AMA
  • Книга стилей AP
  • Стиль APA
  • Руководство по стилю ASA
  • Справочник делового стиля
  • Кембриджское руководство по использованию английского языка
  • Чикагское руководство стиля
  • Ссылаясь на медицину
  • Элементы стиля
  • Элементы типографского стиля
  • Современное английское использование Фаулера
  • Современное английское использование Гарнера
  • Стиль IEEE
  • ISO 690
  • Руководство по стилю MHRA
  • Руководство Microsoft по стилю
  • Справочник ГНД
  • Руководство New York Times
  • Оксфордское руководство по стилю / Правила Нью-Харта
  • Научный стиль и формат (стиль CSE)
  • Турабян: Пособие для писателей

  • Список сокращений в руководствах по стилю

А гид по стилю или же руководство по стилю представляет собой набор стандартов для написания, форматирования и оформления документов. Его часто называют таблица стилей, хотя этот термин также другие значения. Стандарты могут применяться либо для общего использования, либо быть обязательными для использования в отдельной публикации, в конкретной организации или в определенной области.

Руководство по стилю устанавливает стандарт стиль требования к улучшению коммуникация путем обеспечения последовательность как в документе, так и в нескольких документах. Поскольку практики различаются, в руководстве по стилю могут быть установлены стандарты для использования в таких областях, как пунктуация, заглавные буквы, со ссылкой на источники, форматирование чисел и дат, внешний вид таблиц и другие области. Руководство по стилю может потребовать определенных лучшие практики в использование, языковая композиция, визуальная композиция, орфография и типография. За академический и технический документы, руководство может также применять передовой опыт в этика (Такие как авторство, этика исследования, и раскрытие ), педагогика (Такие как экспозиция и ясность), и соответствие (технический и регулирующий ).

Руководства по стилю специализируются на разных направлениях, от общего использования широкой публикой до широкого спектра специализированных применений, например, для студентов и ученых различных специальностей. академический дисциплины, медицина, журналистика, право, правительство, бизнес в целом и отдельные отрасли. Период, термин домашний стиль относится к индивидуальному руководству по стилю конкретного издателя или организации.

Разновидности

Руководства по стилю сильно различаются по объему и размеру.

Размеры

Это разнообразие по объему и длине обеспечивается каскадированием одного стиля над другим, аналогично тому, как стили каскадируются. в веб-разработке и на рабочем столе каскадировать CSS стили.

Краткое руководство по стилю часто называют таблица стилей. Всеобъемлющее руководство обычно бывает длинным и часто называется руководство по стилю или же руководство по стилю (MOS или же MoS). Во многих случаях такой проект, как один книга, журнал, или же монография series обычно имеет короткую таблицу стилей, которая переходит в несколько более крупное руководство по стилю организации, например издательский компания, контент которой обычно называют домашний стиль. Большинство стилей дома, в свою очередь, перетекают отраслевое или профессиональное руководство по стилю это даже более комплексно. Вот некоторые примеры этих руководств по отраслевому стилю:

  • AP стиль для журналистики и делового письма
  • Чикагский стиль для делового письма и корпоративного общения, а также академического письма и публикации.
  • USGPO стиль или же Стиль AGPS для государственных изданий
  • Оксфордский стиль для научных публикаций и читателей
  • Стиль APA и Стиль ASA для социальных наук
  • CSE стиль для различных физических наук
  • Стиль ACS по химии
  • AMA стиль для медицины
  • Синяя книга стиль для закона

Наконец, эти справочные работы проходят каскадом по орфографический нормы используемого языка (например, Английская орфография для англоязычных публикаций). Это, конечно, может зависеть от национального разнообразия, такого как различные варианты американского английского и британского английского.

Темы

Некоторые руководства по стилю посвящены конкретным тематическим областям, таким как графический дизайн, включая типография. Руководства по стилю веб-сайтов охватывают визуальные и технические аспекты публикации, а также текст.

Руководства по стилю, которые охватывают использование может предложить способы описания людей, которые избегают расизм, сексизм, и гомофобия. Руководства в конкретных научных и технических областях охватывают номенклатура, который определяет имена или классификационные метки, которые являются предпочтительными, поскольку они четкие, стандартизированные и онтологически звук (например, таксономия, химическая номенклатура, и номенклатура генов ).

Обновление

Большинство руководств по стилю время от времени пересматриваются с учетом изменений в соглашениях и правилах. использование. Частота обновления и контроль версий определяются тематикой. Для руководств по стилю в справочная работа формат, новый редакции обычно появляются каждые 1–20 лет. Например, Книга стилей AP ежегодно пересматривается, а руководства Chicago, APA и ASA находятся в 17-м, 6-м и 4-м изданиях соответственно. Многие стили домов и отдельные стили проектов меняются чаще, особенно для новых проектов.

Примеры

Международный

Несколько основных руководств по стилю для технических и научных коммуникаций были определены международными организации по стандартизации. Одним из примеров является ISO 215 Документация — Представление материалов для периодических и других периодических изданий..[1]

Европа

В Евросоюз издает Межведомственное руководство по стилю — охватывающий 24 языка по всему Европейскому Союзу. Это руководство является «обязательным» для всех сотрудников учреждений ЕС, которые занимаются подготовкой документов и работ ЕС.[2] В Главное управление переводов из Европейская комиссия издает собственный Руководство по английскому стилю, предназначенный в первую очередь для англоязычных авторов и переводчиков, но также нацеленный на обслуживание более широкой читательской аудитории.[3]

Австралия

  • Руководство по стилю: для авторов, редакторов и печатников от Snooks & Co для Департамент финансов и администрации. 6-е изд. ISBN  0-7016-3648-3.
  • Австралийский справочник по юридическому цитированию
  • Австралийское руководство научного стиля (AMOSS) — онлайн от Биотекста; иллюстрировано Биотекстом. 1-е изд. ISBN  978-0-9946369-0-4

Канада

Общий

  • Книга стилей канадской прессы: руководство для писателей и редакторов, 14-е изд. Торонто: Канадская пресса, 2006. Путеводитель по газетному стилю в Канаде. ISBN  0-920009-38-7.
  • Редактирование канадского английского, 2-е изд. Подготовлено для Ассоциации редакторов Канады / Канадской ассоциации ревизоров Кэтрин Крэгг, Барбара Чарнеки, Ирис Хоссе Филлипс, Кэтрин Вандерлинден и Шейла Протти. Торонто, Онтарио: Макфарлейн Уолтер и Росс, 2000.
  • Руководство по стилю Комиссии по государственной службе. Оттава: Правительство Канады, 2011.
  • Общественные работы и государственные услуги Канады, Бюро переводов. Канадский стиль: руководство по написанию и редактированию. Ред. Ред. Торонто: Dundurn Press, 1997. ISBN  1-55002-276-8.[4]

Журналистика

  • J.A. Макфарлейн и Уоррен Клементс. Книга стилей земного шара и почты: руководство по языку и использованию, изм. изд. Торонто: Макклелланд и Стюарт, 1998.

Закон

  • Юридический журнал Макгилла. Canadian Guide to Uniform Legal Citation / Manuel canadien de la référence juridique. 8-е изд. Торонто: Карсвелл, 2014.[5]

объединенное Королевство

Общий

  • Стиль, к Ф. Л. Лукас, 1955; 3-е издание, Harriman House, 2012 г.
  • Копировальное редактирование Мясника: Кембриджское руководство для редакторов, копировальных редакторов и корректоров, Джудит Бутчер, Кэролайн Дрейк, Морин Лич. 4-е изд. Кембридж, 2006: Издательство Кембриджского университета ISBN  978-0521847131
  • Словарь современного английского языка Фаулера. Эд. Джереми Баттерфилд. 4-е изд. Oxford University Press, 2015.  ISBN  978-0-19-966135-0 (Твердая обложка). На основе Современное английское использование Фаулера, к Генри Ватсон Фаулер.
  • Королевский английский, к Генри Ватсон Фаулер и Фрэнсис Джордж Фаулер.
  • Правила Нового Харта 2005 г. (ранее переиздавалось как Оксфордское руководство по стилю, 2002).
  • Полные простые слова, к Сэр Эрнест Гауэрс.
  • Руководство по стилю MHRA: руководство для авторов, редакторов и авторов тезисов, 2-е изд. Лондон: Ассоциация современных гуманитарных исследований, 2008.
  • Оксфордское руководство по стилю. Под редакцией Роберта Риттера. Oxford – New York: Oxford University Press, 2003 (переиздано как Новое руководство по стилю Оксфорд, 2012). Сочетает Правила Нового Харта (2002) и Оксфордский словарь для писателей и редакторов (2000).
  • Использование и злоупотребление, к Эрик Партридж.

Журналистика

  • Руководство по стилю BBC News: посредством Британская радиовещательная корпорация.[6]
  • Руководство по стилю Economist: к Экономист.[7]
  • Руководство по стилю Guardian: к Хранитель.[8]
  • Времена Руководство по стилю и использованию. Ред. Ред. Составлено Тимом Остином. Лондон: Times Books, 2003.[9]

Соединенные Штаты

В Соединенных Штатах использование руководства по стилю зависит от отрасли и цели контента. Некоторые государственные корпорации следуют Книга стилей Associated Press для контента, связанного с журналистикой (например, пресс-релизов), но используйте Чикагское руководство стиля для печатных и цифровых документов, таких как отчеты или содержимое веб-сайтов. Многие корпорации создают свои собственные руководства по внутреннему стилю на основе нескольких руководств по стилю. Журналисты используют Книга стилей Associated Press. Книжные издатели и авторы журналов, требующих справочных разделов, обычно выбирают Чикагское руководство стиля, в то время как научные статьи часто следуют Руководство по стилю MLA и руководство по научным публикациям.[10] Один из самых популярных грамматика руководства, используемые в письме от третьего лица, Элементы стиля.

Общий

  • Осторожный писатель, к Теодор Бернштейн.
  • Элементы стиля, к Уильям Странк мл. и Э. Б. Уайт. (Обычно называется «Странк и Белый»)
  • Стиль: Уроки ясности и изящества, к Джозеф М. Уильямс
  • Хорошо понятный тезаурус, к Том Хилер
  • Чикагское руководство стиля, 17-е изд. Чикаго – Лондон: Издательство Чикагского университета, 2017.
  • Руководство Мерриам-Вебстер для писателей и редакторов. Составлено редакцией Collegiate Dictionary Merriam-Webster. Спрингфилд, Массачусетс: Merriam-Webster, 1998. (ред. Стандартное руководство Вебстера по американскому стилю, 1985)
  • Руководство по стилю и использованию Нью-Йоркской публичной библиотеки для писателей. Нью-Йорк: HarperCollins, 1994.
  • Уильям А. Сабин. Справочное руководство Грегга: Руководство по стилю, грамматике, использованию и форматированию, 10-е изд. Бостон: Макгроу-Хилл, 2005.
  • Слова в тип, 3-е изд. На основе исследований Марджори Э. Скиллин, Роберта М. Гей и других авторитетных источников. Энглвуд Клиффс, Нью-Джерси: Прентис-Холл, 1974.

Академические работы

  • Справочник ГНД для авторов исследовательских работ, 8-е изд. Нью-Йорк: Американская ассоциация современного языка, 2016 г. (обычно называется «Стиль MLA «.)
  • Руководство по стилю MLA и руководство в научных публикациях, 3-е изд. Нью-Йорк: Американская ассоциация современного языка, 2008 г. Прекращено с 2016 г.[11]
  • Уильям А. Сабин. Справочное руководство Грегга: Руководство по стилю, грамматике, использованию и форматированию. 10-е изд. Бостон: Макгроу-Хилл, 2005.
  • Кейт Л. Турабян. Пособие для авторов научных статей, диссертаций и диссертаций: Чикагский стиль для студентов и исследователей, 7-е изд. Отредактировано Уэйном К. Бутом, Грегори Г. Коломбом, Джозефом М. Уильямсом и редакцией Чикагского университета. Чикаго: University of Chicago Press, 2007. (Обычно называется «Турабский стиль «.)
  • Кейт Л. Турабян. Руководство для студентов по написанию статей для колледжа, 4-е изд. Отредактировано Грегори Г. Коломбом, Джозефом М. Уильямсом и редакцией Чикагского университета. Чикаго: Издательство Чикагского университета, 2010.

Бизнес

  • Чикагское руководство стиля, 17-е изд. Чикаго – Лондон: Издательство Чикагского университета, 2017.[12]
  • Книга стилей Associated Press и Брифинг по Закону о СМИ, 44-е изд. Под редакцией Даррелла Кристиана, Салли Якобсен и Дэвида Минторна. Нью-Йорк: Ассошиэйтед Пресс, 2009.[13]
  • Справочник делового стиля, руководство от А до Я для эффективного письма на работе, Хелен Каннингем и Бренда Грин.[14]
  • Руководство Wall Street Journal по деловому стилю и использованию. Под редакцией Пола Р. Мартина. Лондон: Свободная пресса, 2002.

Правительство

  • Полное руководство по цитированию государственных информационных ресурсов: руководство для писателей и библиотекарей. Ред. Ред. Под редакцией Дайан Л. Гарнер и Дайан Х. Смит. Бетесда, Мэриленд: Информационная служба Конгресса для круглого стола с правительственными документами, Американская библиотечная ассоциация, 1993.
  • Министерство обороны, см. Военный стандарт США.
  • Руководство по стилю правительственной типографии США, 31-е изд. Вашингтон, округ Колумбия: Государственная типография, 2016.[15]
  • Геологическая служба США. Предложения авторам отчетов Геологической службы США, 7-е изд. Отредактировано и отредактировано Уоллесом Р. Хансеном. Вашингтон, округ Колумбия: Правительственная типография, 1991.

Журналистика

  • Сборник стилей и брифинг Associated Press по закону о СМИ, 44-е изд. Под редакцией Даррелла Кристиана, Салли Якобсен и Дэвида Минторна. Нью-Йорк: Ассошиэйтед Пресс, 2009.[16]
  • Руководство по стилю и использованию New York Times. Ред. Ред. Отредактированный Алланом М. Сигалом и Уильямом Г. Коннолли. Нью-Йорк: Three Rivers Press, 1999.

Закон

  • Руководство по цитированию ALWD: профессиональная система цитирования, 3-е изд. Под редакцией Ассоциации директоров юридических писателей и Дарби Дикерсон. Нью-Йорк: Аспен, 2006.
  • Синяя книга: единая система цитирования, составленный Гарвардский юридический обзор Ассоциация Columbia Law Review, то Обзор права Пенсильванского университета, а Йельский юридический журнал. Юристы в большинстве юридических школ США обучаются этому.
  • Брайан А. Гарнер. Элементы юридического стиля, 2-е изд. Нью-Йорк: Издательство Оксфордского университета, 2002.
  • Руководство по правовому цитированию Чикагского университета, 2-е изд. Под редакцией Юридического обзора Чикагского университета. 2000 г.

Несмотря на почти единообразное использование Bluebook, почти в каждом штате есть правила апелляционного суда, которые определяют методы цитирования и стили письма, характерные для этого штата, и Верховный суд Соединенных Штатов имеет свой собственный метод цитирования. Однако в большинстве случаев они взяты из Bluebook.

Есть также несколько других руководств по цитированию, доступных для юридических писателей, широко используемых в Соединенных Штатах. Практически все крупные юридические фирмы имеют собственное руководство по цитированию и несколько крупных издателей юридических текстов (West, Lexis-Nexis, Hein, и другие.) поддерживают свои собственные системы.

Религия

  • Католическая служба новостей. Книга стилей CNS по религии: справочное руководство и руководство по использованию, 3-е изд. Вашингтон, округ Колумбия: Служба католических новостей, 2006.
  • Небольшой справочник по стилю великих христианских писателей и издателей, 13-е изд. Леонард Г. Госс и Кэролайн Стэнфорд Госс.
  • Справочник стиля SBL для библейских исследований и связанных дисциплин, 2-е изд. Отредактированный Патриком Х. Александром. Атланта: SBL Press, 2014 (1-е изд .: Справочник стиля SBL: для изучения древнего Ближнего Востока, Библии и раннего христианства. Пибоди, Массачусетс: Хендриксон, 1999).
  • Репортаж о религии 2: сборник стилей о лучших традициях религии. Под редакцией Дайан Коннолли и Дебра И. Мейсон. Вестервиль, Огайо: журналисты новостей религии, 2007.

Естественные науки

  • Американское химическое общество (ACS). В основном используется для физические науки, Такие как физическая химия, физика, и смежных дисциплин. Обычно называется «Стиль ACS «.
    • Руководство по стилю ACS: эффективная передача научной информации, 3-е изд. Отредактированный Энн М. Когхилл и Лоррин Р. Гарсон. Вашингтон, округ Колумбия: Американское химическое общество, 2006; и
    • Руководство по стилю ACS: Руководство для авторов и редакторов (1997).
  • Роберт Томас Бейер, Американский институт физики Руководство по стилю, Нью-Йорк. 1-е изд .: 1951. 1990: 4-е изд.
  • Американское математическое общество. Руководство по стилю AMS, Под редакцией Мэри Летурно и Дженнифер Райт Шарп, Провиденс, Род-Айленд, 2017.
  • Американская медицинская ассоциация. Руководство по стилю: Руководство для авторов и редакторов, 10-е изд. Под редакцией Шерил Айверсон. Oxford University Press, Нью-Йорк 2007. В основном используется в лекарство. (Обычно называется «стиль Ама».)
  • Американское общество микробиологии. Руководство по стилю ASM для журналов и книг, Вашингтон, округ Колумбия, 1991.
  • Научный стиль и формат: Руководство CSE для авторов, редакторов и издателей, 7-е изд. Составлено Комитетом по руководству по стилю Совет научных редакторов. Рестон, Вирджиния: Совет научных редакторов в сотрудничестве с Rockefeller University Press, 2006. Широко используется в естественных науках, особенно в науках о жизни. (Обычно называется «CSE стиль «.)

Социальные и когнитивные науки

  • КАК. Гид по стилю. 5-е изд. Вашингтон, округ Колумбия: Американская социологическая ассоциация, 2014.
  • Руководство по публикациям Американской психологической ассоциации, 6 изд. Вашингтон, округ Колумбия.: Американская психологическая ассоциация, 2009. В основном используется в социальные науки. (Обычно называется «Стиль APA «.)
  • Руководство по стилю для политологии, изм. изд. Вашингтон, округ Колумбия: Комитет по публикациям Американской ассоциации политических наук, 2006.
  • «Язык Таблица стилей «.[17] Лингвистическое общество Америки. В первую очередь для журнала Язык, но также используется в других местах.
  • «Единая таблица стилей для лингвистики».[18] Лингвистическое общество Америки, 2007.

Веб-публикации

  • Дженис Уокер и Тодд Тейлор. Колумбийский путеводитель по онлайн-стилю, 2-е изд. Нью-Йорк: издательство Колумбийского университета, 2006.
  • Руководство Microsoft по стилю к Корпорация Майкрософт.
  • Yahoo! Руководство по стилю: исчерпывающий справочник по написанию, редактированию и созданию контента для Интернета, Крис Барр и Yahoo! Сотрудники редакции.
  • Википедия Руководство по стилю

Рекомендации по цитированию веб-контента также появляются в подробных руководствах по стилю, таких как Oxford / Hart, Chicago и MLA.

Смотрите также

  • Стиль цитирования
  • Графический устав
  • Дикция
  • Документация
  • Спорные использования
  • Английский стиль письма
  • Список руководств по стилю
  • Рецепт и описание
  • Расстояние между предложениями в руководствах по языку и стилю
  • Написание
  • Таблица стилей (значения)

Рекомендации

  1. ^ «ISO 215: 1986 — Документация — Представление материалов для периодических и других периодических изданий». Iso.org. 19 сентября 2012 г.. Получено 17 июн 2013.
  2. ^ Бюро публикаций Европейского Союза (24 июля 2008 г.). «Межведомственное руководство по стилю». Европа. Европейский Союз 12 мая 2010 г.
  3. ^ Генеральный директорат переводов (Европейская комиссия). «Руководство по английскому стилю». Евросоюз.
  4. ^ Бюро переводов, Общественные работы и государственные услуги Канада (1997). Канадский стиль: руководство по написанию и редактированию (Мягкое покрытие) (Пересмотренная ред.). Торонто: Dundurn Press Ограничено. ISBN  978-1-55002-276-6. Получено 27 ноября 2017.
  5. ^ Юридический журнал Макгилла / Revue de droit de McGill (2014). Canadian Guide to Uniform Legal Citation / Manuel canadien de la référence juridique (Твердая обложка) (на французском и английском языках) (8-е изд.). Торонто: Карсвелл. ISBN  978-0-7798-6075-3. Получено 27 ноября 2017.
  6. ^ Гид по стилю BBC News (PDF), получено 18 апреля 2012
  7. ^ Руководство по стилю Economist, 10-е издание (2010 г.), ISBN  1-84668-175-8. Онлайн-версия по состоянию на май 2012 г.
  8. ^ Руководство по стилю Guardian, Лондон, 19 декабря 2008 г., получено 13 апреля 2011
  9. ^ Руководство по стилю и использованию Times (2003) ISBN  0-00-714505-5. Онлайн-версия по состоянию на май 2011 г. archive.org
  10. ^ «Что такое стиль MLA?», mla.org, Ассоциация современного языка, 2011, Интернет, 31 января 2011 г.
  11. ^ «Спросите MLA: будет ли опубликована новая редакция Руководства по стилю MLA?». Центр стиля MLA. Ассоциация современного языка. 8 апреля 2016 г. В архиве из оригинала 11 июля 2018 г.. Получено 7 ноября 2018.
  12. ^ Какое значение имеют руководства по стилю в деловом письме: https://supercopyeditors.com/blog/style/style-guides-in-business-writing/
  13. ^ Книга стилей Associated Press, получено 13 апреля 2011
  14. ^ Запись каталога Библиотеки Конгресса для Справочник делового стиля, 2-е издание: http://lccn.loc.gov/2012033481
  15. ^ «Руководство по стилю типографии правительства США». Издательство правительства США. 2016 г.
  16. ^ Книга стилей Associated Press, получено 13 апреля 2011
  17. ^ «Язык Таблица стилей «(PDF), Лингвистическое общество Америки.
  18. ^ «Единая таблица стилей «(PDF), Лингвистическое общество Америки.

внешняя ссылка

  • Но в книге стилей сказано … — Сообщение в блоге о злоупотреблении таблиц стилей, автор Билл Уолш из Вашингтон Пост
  • Раздаточные материалы о написании руководств по стилю, с конференции Американское общество редакторов-копировщиков в 2007
    • Уильям Дж. Коннолли. «Как написать книгу стилей за 10 простых шагов» (PDF). Архивировано из оригинал (PDF) 21 августа 2010 г.
    • Дуг Кума. «Создание собственной книги стилей» (PDF). Мередит Special Interest Media. Архивировано из оригинал (PDF) 21 августа 2010 г.
  • Журнал языков »Поиск в 43 книгах стилей

Как создать идеальное руководство по фирменному стилю

Одним из наиболее важных активов бренда для любой компании является руководство по фирменному стилю (brand style guide). Оно обеспечивает последовательность в коммуникациях бренда, что очень важно для его роста и успеха.

При создании айдентики бренда компании очень часто фокусируются исключительно на логотипе или основном фирменном знаке, а затем переходят к созданию маркетинговых материалов или разработке сайта.

Однако правильный способ создать айдентику бренда — это сформировать систему. Система превращает ваш бренд из простой рубашки в костюм-тройку, что позволяет ему выглядеть лучше и восприниматься соответствующим образом.

После создания системы важно установить набор правил и рекомендаций по внедрению и использованию различных элементов айдентики бренда. Документ, диктующий эти правила и рекомендации, называется руководством по фирменному стилю.

Мы предлагаем вашему вниманию 9 советов Маш Бонигала (Mash Bonigala) из www.spellbrand.com по созданию идеального руководства.

Содержание статьи

Основные разделы руководства по фирменному стилю

Обложка и содержание
Введение и контекст
Дизайн логотипа
Цветовая палитра и оттенки
Типографика и иерархия шрифтов
Корпоративная иконографика
Сеточные системы
Изображения и режимы наложения
Презентации и другие печатные материалы

Основные разделы руководства по фирменному стилю 

Основные разделы руководства по фирменному стилю

Для создания нужной узнаваемости бренда руководство по фирменному стилю должно включать следующие разделы:

  • Обложка
  • Содержание
  • Введение
  • Дизайн логотипа

    • Знакомство с логотипом
    • Использование логотипа
    • Элементы логотипа
    • Охранное поле
    • Недопустимое использование логотипа
  • Система корпоративных цветов

    • Корпоративные цвета
    • Основной цвет
    • Система вторичных цветов
  • Корпоративная типографика

    • Корпоративные шрифты
    • Основной шрифт
    • Дополнительный шрифт
    • Иерархия шрифтов
  • Корпоративная иконографика
  • Сеточные системы (grid systems)

    • Сеточная система для печатных материалов
    • Размещение логотипа
    • Колонки и отступы
    • Вертикальная сеточная система для планшетов
  • Изображения и режимы наложения (blending modes)

    • Стиль корпоративных изображений
    • Цвета корпоративных изображений
    • Черно-белые корпоративные изображения
    • Режимы наложения и варианты
    • Сеточные системы для изображений
  • Презентации и другие печатные материалы
  • Заключение

Рассмотрим каждый из этих разделов в отдельности.

Обложка и содержание

Обложка и содержание

Для каждого руководства по фирменному стилю очень важно настроить контекст, голос бренда и нарратив. Сделать это можно на обложке, в содержании и во введении.

Начните с большого и красивого макета логотипа на внутренней странице. Будет хорошо, если вы разместите логотип на фоне основного цвета и используете версию логотипа, которая будет выделяться на этом фоне.

Разместите на первой странице содержание с номерами страниц. При возможности разбейте его на разделы и пронумеруйте соответствующим образом.

Введение и контекст

Введение и контекст

Если у вас есть история бренда, то руководство по фирменному стилю — самое подходящее место, чтобы поделиться ей.

Когда история свежа, а вдохновение сильно, все стейкхолдеры и члены команды проникаются историей бренда. Но со временем ее влияние ослабевает. Напомните о ней в своем руководстве.

Как минимум включите в этот раздел текст о важности руководства по фирменному стилю и о том, как его использовать.

Дизайн логотипа

Дизайн логотипа

Дизайн логотипа

В этом разделе необходимо изложить основы дизайна вашего логотипа. Если у вас есть дополнительный фирменный знак, создайте для него отдельный раздел.

Цель — не только перечислить технические характеристики логотипа, но и дать рекомендации о том, как стоит и как не стоит использовать логотип.

Технические характеристики логотипа включают размеры его основных компонентов, таких как иконка и типографика, расстояние и соотношение между ними, интервалы и отступы вокруг логотипа и так далее. Рекомендации также могут включать допустимые форматы файлов.

Цветовая палитра и оттенки

Цветовая палитра и оттенки

Для поддержания последовательности бренда (brand consistency) важное значение имеет иллюстрация цветовой палитры.

Цветовые схемы — один из важнейших аспектов любого успешного бренда. Если вы посмотрите на любой из супербрендов, то заметите, что у них, как правило, есть свой собственный цвет.

Выбор правильного цвета, а затем последовательное его применение во всех стратегиях брендинга — ключ к созданию нужной вспоминаемости бренда.

Теория цвета дает нам четкое представление о гармонических цветовых сочетаниях. Цвета обеспечивают не только визуальное наслаждение. Они также способны передавать сообщения посредством различных чувств, которые они вызывают у людей.

Типографика и иерархия шрифтов

Типографика и иерархия шрифтов

Когда речь идет о дизайне логотипа, ценность типографики нельзя воспринимать как должное. Если цель логотипа — передать некое сообщение, нет лучшего способа сделать это, чем с помощью букв и слов.

Поскольку для логотипов важна эстетика, необходимо выбрать лучший стиль шрифтового оформления (lettering style).

Раздел типографики в руководстве по фирменному стилю — это раздел, на который ссылаются большинство поставщиков, веб-дизайнеров и других лиц, контактирующих с брендом. Он включает основной шрифт, а также вторичные или комплиментарные шрифты разного начертания и стиля.

Важное значение имеет также иерархия шрифтов. Она показывает, как выглядит текст разного размера и начертания.

Типографика и иерархия шрифтов

Корпоративная иконографика

Корпоративная иконографика

Иконографика как раздел истории искусств изучает выявление, описание и интерпретацию изображений: изображенных предметов, отдельных композиций и деталей и др.

Создание иконок, соответствующих основной айдентике бренда, повышает ценность визуальной системы и помогает донести дополнительные сообщения до целевой аудитории.

Разработайте набор иконок для использования на сайте или в печатных материалах, повышающих ценность бренда. Не стоит поддаваться искушению и покупать готовые наборы иконок.

Сеточные системы

Сеточные системы

Сеточные системы

В графическом дизайне сетка — это структура (обычно двухмерная), состоящая из серии пересекающихся прямых (вертикальных, горизонтальных и угловых) или изогнутых направляющих линий, используемых для структурирования контента.

В брендинге сеточные системы помогают создать последовательную архитектуру того, как будут выглядеть и восприниматься различные активы и компоненты бренда.

Будучи невидимыми, сеточные системы играют решающую роль в том, что будет считаться приятным или нет на визуальном языке бренда.

Сеточные системы очень важны в печатных материалах, таких как фирменные бланки, визитные карточки, плакаты, а также в Интернете и используемых фотографиях.

Изображения и режимы наложения

Изображения и режимы наложения

Визуальный язык бренда не ограничивается дизайном логотипа или полиграфии. Он выходит за рамки очевидных точек соприкосновения и включает такие активы, как фотографии и изображения, которые бренд использует на своем сайте, в печатных материалах и в социальных сетях.

Важно сформировать рекомендации относительно того, как должны выглядеть и восприниматься фотографии и изображения бренда. Это включает в себя не только тип используемых фотографий, но и их стиль.

Для создания уникального стиля, который можно идентифицировать с брендом, очень важны режимы наложения:

  • Цвет, полученный в результате умножения базового цвета на совмещенный, всегда будет более темный.
  • Умножение любого цвета на черный дает черный цвет.
  • Умножение любого цвета на белый оставляет цвет неизменным.

Перед использованием фотографий и изображений важно также учитывать их настроение. Оно должно соответствовать основным ценностям и истории бренда.

Презентации и другие печатные материалы

Презентации и другие печатные материалы

Презентация и другие печатные материалы также должны соответствовать правилам руководства по фирменному стилю. Ничто не должно быть оставлено на волю случая или интерпретации.

Необходимо продумать стиль и дизайн-макет, а также создать соответствующий раздел в руководстве по фирменному стилю. Он может включать упоминание о фонах, цветах, сетках и многом другом.

Как правило, в руководстве по фирменному стилю вы найдете шаблоны сетки. Они также могут быть включены в брендбук вместе с голосом бренда, заявлением о миссии и фирменными цветами.

Дополнительные печатные материалы, такие как бланки, визитные карточки, счета-фактуры, также должны быть включены в руководство вместе с указанием размеров и других необходимых характеристик.

Высоких вам конверсий!

По материалам: spellbrand.com. Автор: Mash Bonigala.

06-04-2022

Список статей Викимедиа

A руководство по стилю или руководство по стилю — это набор стандартов для написания и дизайн документов для общего пользования или для конкретной публикации, организации или области. Реализация руководства по стилю обеспечивает единообразие стиля и форматирования в документе и во многих документах. Набор стандартов для конкретной организации часто называют «домашним стилем». Руководства по стилю являются общими для общего и специализированного использования, для читающей и пишущей аудитории, а также для студентов и ученых различных академических дисциплин, медицины, журналистики, права, правительства, бизнеса и промышленности.

Содержание

  • 1 Международный
  • 2 Австралия
  • 3 Канада
    • 3.1 Газеты
  • 4 Европейский Союз
  • 5 Великобритания
    • 5.1 Общие положения
    • 5.2 Для юридических документов
    • 5.3 Для журналистики
    • 5.4 Для компьютерной индустрии (программное и аппаратное обеспечение)
  • 6 США
    • 6.1 Для общего письма
    • 6.2 Для юридических документов
    • 6.3 Для научных статей
    • 6.4 Для журналистики
    • 6.5 Для электронных публикаций
    • 6.6 Для бизнеса
    • 6.7 Для компьютерной индустрии (программное и аппаратное обеспечение)
    • 6.8 Руководства по редакционному стилю подготовки рукописи к публикации
  • 7 Академический
  • 8 Сообщества
  • 9 Art
  • 10 См. Также
  • 11 Ссылки
  • 12 Внешние ссылки

International

Международные организации по стандартизации разработали несколько основных руководств по стилю для технической и научной коммуникации.. Они часто используются как элементы и уточняются в более специализированных руководствах по стилю, относящихся к предмету, региону или организации. Вот некоторые примеры:

  • EN 15038, Приложение D — Европейский стандарт для переводческих услуг
  • ISO 8 — Представление периодических изданий
  • ISO 18 — Списки содержания периодических изданий
  • ISO 31 — Количества и единиц
  • — Отрывки для публикации и документации
  • — Представление вкладов в периодические издания и другие периодические издания
  • ISO 690 — Библиографические ссылки — Содержание, форма и структура
  • — Библиографические ссылки — Сокращения типичных слов
  • ISO 999 — Указатель публикации
  • — Титульные листы книги
  • ISO 2145 — Нумерация разделов и подразделов в письменных документах
  • — Представление научных и технических отчетов (отозвано)
  • – Spine названий книг и другие публикации
  • — Презентация тезисов и аналогичных документов
  • ISO 9241 — Эргономика взаимодействия человека и системы

Австралия

  • Руководство по стилю : Для авторов, редакторов и типографий Snooks Co для Depar Управление финансов и администрирования. 6-е изд. ISBN 0-7016-3648-3 .

Канада

  • Канадский стиль: руководство по написанию и редактированию: издано Dundurn Press в сотрудничестве с Общественными работами и Государственной службой Канады Бюро переводов. ISBN 1-55002-276-8 .

Газеты

  • CP Stylebook: Руководство по газетному стилю в Канаде, поддерживаемое Canadian Press. ISBN 0-920009-38-7 .
  • Книга стилей Globe and Mail: изначально создавалась, чтобы помочь писателям и редакторам Globe and Mail представлять ясные, точные и сжатые истории. ISBN 0-7710-5685-0

Европейский Союз

  • Межведомственное руководство по стилю.
  • Руководство по стилю английского («Руководство для авторов и переводчиков в Европейская Комиссия «- исполнительная власть Европейского Союза.)

Соединенное Королевство

Общее

  • Редактирование копий: Кембриджское руководство для редакторов, авторов и издателей Джудит Бутчер 3-е изд. 1992 г. Кембридж: Cambridge University Press ISBN 0-521-40074-0
  • Современное английское использование Фаулера. Ред. RW Burchfield. Rev. 3-е изд.. Лондон: Clarendon Press, 2004. ISBN 0-19-861021-1 (твердый переплет). Основано на современном английском языке, автор Генри Ватсон Фаулер.
  • The King’s English, Генри Ватсон Фаулер и Фрэнсис Джордж Фаулер.
  • Руководство по стилю Oxford (изд. 2003 г.). Объединяет Oxford Guide to Style и Оксфордский словарь для писателей и редакторов, в котором основное внимание уделяется общим проблемам.
  • The Complete Plain Words, сэр Эрн St Gowers.
  • Использование и злоупотребление, Эрик Партридж.

Для юридических документов

  • Оксфордский стандарт цитирования юридических органов (OSCOLA), Факультет Оксфордского университета закона

Для журналистики

  • Руководство по стилю новостей BBC: от Британской радиовещательной корпорации.
  • Руководство по стилю Economist: от The Economist.
  • Руководство по стилю новостей The Fourth Estate: от Fourth Estate Public Benefit Corporation
  • Руководство по стилю Guardian: от The Guardian
  • Руководство по стилю и использованию The Times от The Times.

Для компьютерной индустрии (программное и аппаратное обеспечение)

  • Руководство по стилю технических публикаций Acorn, автор: Acorn Computers. Содержит редакционные правила для текста в RISC OS учебных публикациях, технической документации и справочной информации.
  • RISC OS Style Guide от RISC OS Open Limited. Содержит рекомендации по дизайну, справку и примеры формулировок диалоговых окон для пользовательского интерфейса программного обеспечения.

США

В США как корпоративные, так и журналистские формы массовой коммуникации полагаются на стили, указанные в Associated Нажмите Stylebook (AP). Классическое руководство по стилю грамматики, которое разработано как дополнение к книге стилей AP, — это Элементы стиля. Вместе эти две книги упоминаются чаще, чем любая другая книга общего стиля письма от третьего лица в США, используемая в большинстве профессий.

Для общего письма

  • The Careful Writer, Теодор Бернштейн.
  • Словарь сомнительных слов Брайсона: Руководство для писателей, как все исправить, от Билла Брайсона.
  • Современное американское использование Гарнера от Брайана А. Гарнера.
  • Классика стиля — представляет собой руководство по написанию от Уильям Странк младший, Эмерсон, Уитмен, По и другие писатели.
  • Книга стилей Associated Press Основные книги ISBN 978-0-917360-63-3 .
  • Элементы стиля. Авторы Уильям Странк-младший и Э. Б. Уайт. (Часто именуется «Странный и Белый».)

Для юридических документов

  • The Bluebook: Единая система цитирования. Совместно, Harvard Law Review, Yale Law Journal, Columbia Law Review и Penn Law Review.
  • ALWD Guide to Legal Citation, ранее ALWD Citation Manual, Association of Legal Writing Director
  • : The Tanbook, by New York State Reporter

Для научных статей

  • Чикагское руководство по стилю, Чикаго : Издательство Чикагского университета.
  • Руководство для авторов исследовательских работ, тезисов и диссертаций, стиль Чикаго для студентов и исследователей, Кейт Л. Турабиан. Часто упоминается как «Turabian.»
  • Справочник MLA для авторов исследовательских работ, автор Джозеф Гибальди. Часто упоминается как« MLA ».
  • Руководство по публикациям Американского психолога Association, Американская психологическая ассоциация (APA).

Для журналистики

  • The Associated Press Stylebook Basic Books ISBN 978-0-917360-63-3 .
  • Руководство по стилю новостей Fourth Estate: Fourth Estate Public Benefit Corporation
  • Руководство по стилю и использованию New York Times. Аллан М. Сигал и Уильям Дж. Коннолли.
  • The Wall Street Journal Guide to Business Style and Usage, Рональд Дж. Олсоп и сотрудники Wall Street Journal.
  • The BuzzFeed Style Guide: Эмми Фавилла и Меган Паолоне.

Для электронных публикаций

  • Колумбийское руководство по онлайн-стилю, Дженис Уокер и Тодд Тейлор.
  • Руководство по веб-стилю: основные принципы дизайна для создания веб-сайтов, Патрик Дж. Линч и Сара Хор ton.
  • The Associated Press Stylebook, Associated Press, Basic Books ISBN 978-0-917360-63-3 .

Для бизнеса

  • Справочник стилей Associated Press Базовые книги ISBN 978-0-917360-63-3 .
  • Справочник по деловому стилю, Руководство от А до Я для эффективного письма на Работа, Хелен Каннингем и Бренда Грин.
  • Справочное руководство Грегга, Уильям А. Сабин.

Для компьютерной индустрии (программное и аппаратное обеспечение)

  • Руководство по стилю Apple, опубликованное в Интернете от Apple Inc. Содержит рекомендации по редактированию текста в учебных публикациях Apple, технической документации, справочной информации, обучающих программах и пользовательском интерфейсе программного обеспечения.. Более ранней версией было Руководство по стилю публикаций Apple.
  • Руководство по стилю документации для разработчиков Google, опубликованное в Интернете компанией Google. Предоставляет набор редакционных рекомендаций для всех, кто пишет документацию для разработчиков по проектам, связанным с Google.
  • The IBM Style Guide: Conventions for Writers and Editors, 2011, and Developing Quality Technical Information: A Handbook for Writers and Editors, 2014, из IBM Press.
  • Microsoft Writing Style Guide, опубликованного в Интернете Microsoft Corporation. Предоставляет стандарт стиля для технической документации, включая использование терминологии, условных обозначений, процедур, методов проектирования, а также использования знаков препинания и грамматики. До 2018 года Microsoft издала книгу Руководство по стилю для технических публикаций Microsoft.
  • Руководство по стилю написания Mozilla, опубликованную в Интернете на сайте Mozilla.
  • Прочтите в первую очередь! Руководство по стилю для компьютерной индустрии, Sun Technical Publications, 3-е изд., 2010.
  • Руководство по стилю Splunk, опубликовано в Интернете на Splunk. Предоставляет справочник по стилю письма для всех, кто пишет или редактирует техническую документацию.
  • Yahoo! Style Guide, 2010.

Руководства по редакционному стилю подготовки рукописи к публикации

  • The Associated Press Stylebook Basic Books ISBN 978-0-917360-63- 3 .
  • Чикагское руководство по стилю, составленное сотрудниками University of Chicago Press.
  • Words into Type, by Marjorie E. Skillin, Roberta

Academic

  • Чикагское руководство стиля. Стандарт академической издательской индустрии, включая многие журнальные публикации.
  • Руководство для авторов курсовых, тезисов и диссертаций (часто называемое «турабским стилем») — Издано Кейт Л. Турабиан, секретарь магистерской диссертации в Чикагском университете с 1930 по 1958 год. Школа требовала ее одобрения для каждой магистерской и докторской диссертации. Ее стилистические правила полностью соответствуют Чикагскому руководству по стилю, хотя есть некоторые отличия.
  • Руководство по стилю ACS — для научных статей, опубликованных в журналах из Американского химического общества.
  • Руководство по стилю Американской медицинской ассоциации — для медицинских статей, опубликованных в журналах Американской медицинской ассоциации.
  • Руководство по стилю Американской психологической ассоциации — для поведенческих и социальных наук; опубликовано Американской психологической ассоциацией.
  • Руководством по стилю Американской социологической ассоциации — для социальных наук; опубликовано Американской социологической ассоциацией.
  • — для геологических отчетов в промышленности, академических кругах и других дисциплинах.
  • Справочник по техническому письму Джеральда Дж. Алреда, Чарльза Т. Брусо и Уолтер Э. Олю — за общие технические работы.
  • Стиль IEEE — используется во многих технических исследованиях, особенно в тех, которые касаются информатики.
  • Леонарда Г. Госса и Кэролайн Стэнфорд. Госс — предоставляет явно религиозную экспертизу стиля и языка для писателей и редакторов в — ISBN 978-0-8054-2787-5 .
  • Руководство по стилю MHRA — для искусства и гуманитарные науки ; опубликовано Ассоциацией современных гуманитарных исследований. Доступно для бесплатной загрузки (см. Статью).
  • Руководство по стилю MLA и Руководство по MLA для авторов исследовательских работ — для предметов искусств и гуманитарные ; опубликовано Ассоциацией современного языка Америки (MLA).
  • SBL Handbook of Style — Society of Biblical Literature style manual специально для области древнего Ближнего Востока, библейские и раннехристианские исследования. Руководство по стилю SBL включает рекомендуемый стандартный формат для сокращения основных источников в древневосточных, библейских и ранних христианских исследованиях.
  • Научный стиль и формат: Руководство CSE для авторов, редакторов и издателей — для научные статьи, опубликованные Советом научных редакторов (CSE), группой, ранее известной как Совет редакторов биологии (CBE).
  • Руководство по стилю для политологии — используется многими американские политологические журналы; опубликовано Американской ассоциацией политологии.

Сообщества

  • GLAAD Справочное руководство по СМИ, 8-е изд., Справочное руководство по СМИ колледжа GLAAD, 1-е изд., Справочное руководство по китайским СМИ GLAAD, 1-е изд. — опубликовано GLAAD, чтобы побудить средства массовой информации использовать язык и практику с участием ЛГБТ. Доступна для свободного скачивания.

Art

  • Ассоциация искусства Редакторы Стиль Руководство

Смотрите также

  • Цитирование
  • дикция
  • Documentation
  • Спорные использование
  • Английский стиль написания
  • Грамматика
  • Предписание и описание
  • Пунктуация
  • Расстояние между предложениями в руководствах по языку и стилю
  • Орфография
  • Руководство по стилю
  • Стилистика

Ссылки

Внешние ссылки

Сейчас многие компании спешно организуют удаленную работу для сотрудников. Этот процесс неизбежно сопряжен с составлением инструкций для технически слабых пользователей, а написание документов возлагается на ИТ-отделы. Сегодня я хочу предложить в помощь ИТ-специалистам свое мини-руководство по стилю технических инструкций.

[+] Сегодня в программе

Предпосылки

Многие вещи, очевидные системным администраторам и опытным пользователям, абсолютно непонятны людям, далеким от ИТ и привыкшим к опеке технических специалистов. Чем лучше написано руководство, тем понятнее оно будет конечным пользователям, что в свою очередь упрощает поддержку и снижает расходы на нее.

Я не планировал публиковать документ, но в одном из чатов Telegram зашел разговор по этой теме, и я указал на недостатки в инструкциях собеседников… В итоге я набросал черновик документа, а коллеги посчитали его полезным и предложили опубликовать для всех.

Ниже текущий текст документа и мои комментарии к нему.

Мини-руководство по стилю для технических инструкций

👉 Актуальная версия документа доступна на Google Docs.

Структура и оформление текста

  • Структурируйте документ, используя заголовки и подзаголовки, чтобы упростить восприятие и навигацию.
  • Добавляйте содержание в начале многостраничных документов.
  • Применяйте нумерованные списки для пошаговых процедур.
  • Ограничивайте процедуры 7-9 шагами, чтобы облегчить восприятие. Длинные процедуры разбивайте логически.
  • Используйте разрывы страниц для отделения процедур друг от друга.
  • Соблюдайте параллельную структуру в списках. Например, в этом списке все предложения начинаются с глаголов в повелительном наклонении, поэтому неправильно было бы начать этот пункт словами «Соблюдение параллельной структуры обязательно…».
  • Не злоупотребляйте цветным шрифтом, особенно красным. Вместо целого предложения или абзаца достаточно выделить первое слово, например, «Важно!».

Язык

  • Пишите инструкции понятным русским языком и не используйте сленг («виндовс», «винчестер» и пр. недопустимы).
  • Обращайтесь непосредственно к читателю. Например, пишите «вы можете» вместо «пользователь может». Это помогает установить прямой контакт с читателем и позволяет избежать сухости в повествовании.
  • Давайте четкие указания в инструкциях, используя глаголы в повелительном наклонении. Например, «откройте» и «перейдите», вместо «пользователь открывает» или «необходимо перейти».
  • Избавляйтесь от лишних слов, не добавляющих ценности повествованию и тем более инструкциям. Например, в пошаговой процедуре вместо «После этого необходимо ввести» достаточно «Введите».
  • Избегайте слишком длинных предложений, в которых могут потеряться читатели. Если ваше предложение содержит более 30 слов, разделите его на два, либо преобразуйте в маркированный список в случае, когда перечисляются однородные пункты.
  • Проверяйте правописание программными средствами, но помните, что это не гарантирует отсутствия ошибок. Прочтите статью вслух для выявления стилистических недостатков и орфографических погрешностей.

Картинки

  • Не перегружайте инструкции снимками экрана, чтобы читатели в них не путались. Необязательно сопровождать каждый шаг процедуры картинкой, и она совсем не нужна, если не добавляет ценности повествованию. Не забывайте, что следуя процедуре, читатель уже видит перед собой графический интерфейс программы или операционной системы.
  • Избегайте добавления излишних графических элементов на картинках. Выделяйте только ключевые области картинок маркером, стрелками или прямоугольниками.
  • Соблюдайте интуитивно понятную цветовую гамму графических элементов. Зеленый цвет обозначает правильное действие, красный цвет – неправильное.

Мои комментарии к документу

Первую версию своего руководства по стилям я опубликовал еще во времена конкурсов на OSZone, и даже предлагал один из вариантов в блоге для участников конкурса фишек Windows 8.1. В сегодняшней редакции некоторые тезисы переехали в другие разделы, потому что структура документа – это постоянный поиск идеала.

Профессиональные руководства по стилям легко могут превышать сотню страниц, за что их составителей люто ненавидят писатели:)

Эти документы описывают все возможные нюансы создания технической документации – от шрифтов и особенностей пунктуации до правил размещения графических элементов на картинках и примеров типовых выражений.

При этом требования могут варьироваться в зависимости от целевой аудитории. Например, для ИТ-специалистов и разработчиков допустим более технический язык, а для конечных пользователей программного продукта запрещен страдательный залог без необходимости.

Здесь я публикую базовую версию – самый минимум, умещающийся на одну страницу. Но, как это часто бывает со статьями блога, если вы подметите для себя один-два новых момента, я сочту свою цель достигнутой.

И, конечно, вы все это видели в моих статьях много раз, просто не придавали значения. Открыв любую из них, вы легко убедитесь, что я следую всем пунктам руководства.

Дискуссия

Я предлагаю обсудить, как новые реалии повлияли на ваш рабочий процесс. Например, у меня на текущем проекте была техническая возможность работы из дома, однако клиент требовал трудиться в офисе. Это требование сняли, а сотрудникам просто отдали домой их ПК и мониторы (у многих их либо нет, либо устройства не годятся для эффективной работы).

В комментариях расскажите:

  • что изменилось в вашем рабочем или образовательном процессе
  • какие сложности возникали и как вы с ними справлялись
  • повысилась или снизилась эффективность вашей работы или учебы

руководство по фирменному стилю

Многие компании используют руководство по фирменному стилю среди внутренних документов. Эта книга, более или менее обширная, важна для сохранения четкого корпоративного стиля без изменений, которые могут повлиять на клиентов.

Но Что такое руководство по фирменному стилю? Какие преимущества это дает вам? Как сделать? Если вы хотите знать все об этом документе, вам просто нужно взглянуть на руководство, которое мы подготовили для вас.

Индекс

  • 1 Что такое инструкция по фирменному стилю
    • 1.1 Руководство по фирменному стилю vs руководство по бренду
  • 2 Преимущества
    • 2.1 Вы сэкономите время и ресурсы с помощью руководства по фирменному стилю
    • 2.2 У вас большая последовательность
    • 2.3 Вы улучшаете имидж клиентов
  • 3 Как создать руководство по фирменному стилю
    • 3.1 Структура руководства по фирменному стилю
      • 3.1.1 Введение в руководство по фирменному стилю
      • 3.1.2 логотип
      • 3.1.3 Цвета
      • 3.1.4 композиция
      • 3.1.5 иконки
      • 3.1.6 образность
      • 3.1.7 Книгопечатание

Что такое инструкция по фирменному стилю

Что такое инструкция по фирменному стилю

Первое, что вам нужно знать, это что означает термин «руководство по фирменному стилю». В данном случае мы говорим о бизнес-документе, который устанавливает правила и руководящие принципы, которым должна следовать компания, чтобы предлагать и поддерживать визуальную идентичность как для клиентов, так и для сотрудников.

Другими словами, то, что он делает, установить суть того, какими будут графические элементы бренда и как их применять, как онлайн, так и офлайн. Такие элементы, как тип логотипа, цвета, шрифты …

Эти руководства могут быть очень простыми, особенно для малого бизнеса, или большими обширными руководствами в крупных компаниях. А кто ими пользуется? Что ж, такие компании, как Vodafone, Endesa, Adidas … Они устанавливают правила, которым нужно следовать, не только в отношении логотипов, но и во многих других элементах, таких как реклама в средствах массовой информации, продукты, каталоги, канцелярские товары, телевизионная реклама, социальные сети, оформление. магазинов и др.

Руководство по фирменному стилю vs руководство по бренду

Вы когда-нибудь думали, что руководство по фирменному стилю и руководство по бренду — это одно и то же? Конечно ДА. Но на самом деле все иначе.

Кажется, что обе вещи об одном и том же, но это не так. В то время как руководство по фирменному стилю сосредоточено на графической части бренда, визуальная идентичность этого бренда, фирменный мануал не остается только на «базе», но идет гораздо глубже, даже отражая аспекты, которые нельзя «трогать», такие как корпоративные ценности, тон голоса, способ общения с потенциальными клиентами и так далее.

Таким образом, при создании одного документа и другого, хотя они могут идти рука об руку, руководство по фирменному стилю действительно остается только на основе названия бренда.

Преимущества

Не многие компании имеют руководство по фирменному стилю и, тем не менее, его наличие, а также его использование имеют много преимуществ, которые, возможно, вы еще не осознали. Резюмируем их:

Вы сэкономите время и ресурсы с помощью руководства по фирменному стилю

Представьте, что вы нанимаете человека. Вы проводите для нее экскурсию по компании и рассказываете ей все, что ей нужно знать о фирменном стиле… Это требует времени, а также человек, который ее всему учит, не может работать во время визита к этому работнику.

Но что, если на следующей неделе появится новый рабочий? Вы снова потратите несколько часов своего времени, а вместе с ними и ресурсы, которые вы могли бы использовать для других целей.

Руководство по фирменному стилю позволяет тратить меньше времени, сделайте краткую презентацию и запишите информацию, необходимую для правильного выполнения вашей работы для компании.

У вас большая последовательность

Часто, особенно с течением времени, люди склонны забывать правила, которым следовали вначале. Это как если бы мы широко раскрыли некоторые аспекты, и это, в конце концов, сказывается на компании.

Поэтому, чтобы этого избежать, наличие правил и коммуникаций через руководство по фирменному стилю помогает не забыть их и иметь для всех справедливый «критерий».

Вы улучшаете имидж клиентов

Потому что, имея руководство по фирменному стилю, вы говорите клиентам, что вам не все равно, потому что есть бесперебойная работа бизнеса и что вы общаетесь со своими сотрудниками, чтобы они знали все, что им нужно знать о компании.

Как создать руководство по фирменному стилю

Как создать руководство по фирменному стилю

Сосредотачиваясь на том, как вы должны сделать руководство по фирменному стилю, первое, что вы должны уяснить, — это тип информации, который вам понадобится для его подготовки.

В этом случае его необходимо определить, потому что мы говорим об элементах, которые не должны меняться так часто (поскольку речь идет о том, что покупатели ассоциируют бренд, не меняйте их каждые два на три):

  • Логотип.
  • Цветовая палитра.
  • Типографии.
  • Иконки и символы.
  • Банк изображений.
  • Дополнительно.
  • Приложения.

Все это является основным в руководстве по фирменному стилю, но как насчет структуры? Мы разбираем это для вас.

Структура руководства по фирменному стилю

Этот документ должен следовать порядку, чтобы вся информация была хорошо понятна и не возникало сомнений или проблем при ее применении в произведениях или в любых приложениях, которые выполняются (телевидение, пресса, рекламные щиты и т. Д.).

Структура будет следующей:

Введение в руководство по фирменному стилю

В нем рассказывается о философии, ценностях, личности и тоне бренда. Важно прояснить этот раздел, поскольку он является основой для понимания причин всего остального.

логотип

Логотип — это фундаментальная часть графической идентичности бренда. По этой причине дизайн, цвета и использование.

Некоторые аспекты, которые должны быть отражены, — это, например, пространство, которое необходимо оставить вокруг логотипа, чтобы он не выглядел слишком загруженным, или максимум и минимум логотипа, чтобы он не переставал читать или не выглядел слишком размытым.

Также здесь может быть раздел для вариаций логотипа, чтобы посмотреть, как он будет выглядеть в разных цветах, форматах и ​​т. Д.

Цвета

Хотя мы уже упоминали ранее, что цвета уже покрыты логотипом, в этом случае он углубляется в цвета, в частности, в значения цвета, которые могут быть установлены между тремя: RGB, CMYK, HEX или Pantone (последний является наиболее используемым. потому что он позволяет цвету, который используется, быть тем, который фактически печатается, с той же тональностью).

Как создать руководство по фирменному стилю

композиция

Раздел композиции устанавливает основные правила дизайн должен соответствовать тому, чего вы хотите визуально добиться от бренда.

иконки

Помимо логотипа важны значки и другие элементы, которые должны соответствовать стилю логотипа в целом. Так вот аспекты столь же разные, как и размер указаны из них цвета, которые они будут иметь, когда они не нажимаются и когда они нажимаются, будет ли у них звук или нет, изменится ли текст, который у них есть, и т. д.

образность

В данном случае речь идет о Банк изображений, который компания будет иметь на самом бренде. Это могут быть фотографии, а также иллюстрации, рисунки … Все они должны быть высокого качества и обработаны соответствующим образом, чтобы улучшить видение бренда.

Книгопечатание

Наконец, у нас есть типографика, то есть тип шрифта, который будет использоваться в брендинге. Здесь важны такие аспекты, как размер шрифта, тип интервала, будет ли использоваться темный и / или светлый фон, будут ли заголовки (H1, H2, H3 …) и абзацы или только абзацы и т. Д. подробнее здесь.

Если компания большая, в дополнение к этим пунктам в руководстве по фирменному стилю, в каждое из приложений, которые имеют: для прессы, журналов, веб-рекламы, телевидения, социальных сетей и т. Д., Включены другие специальные.

Вам теперь стало понятнее, что такое руководство по фирменному стилю?

Содержание статьи соответствует нашим принципам редакционная этика. Чтобы сообщить об ошибке, нажмите здесь.

Сообщение Просмотров: 33,177

Учебный публикациям представляют собой структурированные части научно-популярной литературы, подтвержденные действительными доказательствами. Они документируют и публикуют оригинальные исследовательские работы или рассматривают существующие исследование по всем академическим дисциплинам, обычно написанные экспертами в своих областях. Эти литературные произведения могут включать в себя все, что угодно: от университетских исследовательских работ, отчетов, книг, университетских эссе и заданий, тезисов, журнальных статей, обзорных статей, технических статей и многого другого.

Как и все письменные работы, академические публикации также имеют определенный формат. Обычно мы замечаем, что в этих работах используются цитаты, формальный язык и жаргон, они следуют особой структуре для представления информации и выглядят довольно простыми из-за отсутствия цветов или изображений. В этих письменных произведениях можно найти много таких характеристик.

Но кто решает, какому формату следовать? Это может зависеть от профессора, наставника или организации, но все они предписывают использование определенных руководств по стилю, таких как APA, MLA, CMS и т.д. документы в один момент.

В этом посте мы поймем, что такое руководства по стилю, и рассмотрим происхождение и использование различных стилей. Мы также попытаемся понять их цель. Если вы когда-нибудь задумывались, в чем смысл использования этих форматов, вы попали в нужное место.

Что такое руководства по стилю?  

различные признанные руководства по стилю

Изображение Фото: Библиотеки Хесбурга

Руководство по стилю — это набор рекомендуемых правил написания. Руководящие принципы определяют, как будет представлен контент в письменном документе.. Они руководство писатель, устанавливая стандарты для формата, структуры, грамматики, синтаксиса, пунктуации, аббревиатур, составных слов, цитат и т. д. Эти руководства относятся к академической области, то есть в публикациях по различным дисциплинам используется соответствующий тип руководства по стилю.

Эти руководства используются не только для академических публикаций, но также используются брендами, различными отраслями и организациями. Таким образом, они стандартизируют способ представления своего контента. Это видно, например, по их дизайну и языку. Эти усилия лучше отражают тип целевой аудитории. общаться их сообщение и помочь им выделиться среди конкурентов.

Руководства по стилю иногда называют стилями письма. Однако они совершенно разные. Стиль письма относится к характеру письменного содержания. Обычно существует четыре типа стилей письма; убедительный, повествовательный, объяснительный и описательный. Руководства по стилю действительно в определенной степени влияют на написание, устанавливая правила грамматики и пунктуация. Но это не меняет полностью характера литературы, поскольку она больше фокусируется на представлении информации.

Руководства по стилю или руководства по стилю изначально были опубликованы в виде книг, но сегодня они также доступны в Интернете.

Какие существуют типы руководств по стилю?

Существует длинный список руководств по стилю, которые в настоящее время используются во всем мире. Это связано с тем, что любой тип организации, публикующей письменные материалы в больших количествах, скорее всего, будет иметь собственное руководство по стилю. Например, The New York Times Manual, Oxford Guide to Style / New Hart’s Rules и Microsoft Manual of Style.

В англоязычном мире в научных статьях чаще всего используются три руководства по стилю. Это APA, MLA и CMS. Они подробно обсуждаются ниже.

APA Американской психологической ассоциации

APA, сокращение от Американской психологической ассоциации, является одним из наиболее разработанных руководств по стилю. Он логически структурирует эмпирические исследования, должным образом указывает на других авторов и, конечно же, готовит документ, подходящий для подачи в университет или журнал.

Некоторые из общие черты стиля APA: титульный лист, заголовки, подзаголовки, цитаты в тексте, список литературы, все поля установлены на 1 дюйм, двойной интервал, использование стандартных шрифтов, таких как Times New Roman или Arial, установленных между размерами от 10 до 12 пунктов. , использование номеров страниц и аннотации. Требуются аннотации ко всем эссе для всех типов письменных документов, содержащих более 1000 слов.

Этот стиль используется в таких дисциплинах, как социальные науки, психология, антропология, социология, естественные науки, здравоохранение, образование, лингвистика и других научных областях.

Стиль APA был сформулирован в 1929 когда группа ученых из таких областей, как психология, антропология и бизнес решила установить некоторые руководящие принципы для стандартизации способов документирования научной литературы. Они были нацелены на облегчение понимания контента для более широкой аудитории.

Публикация APA 7-е издание

7-е издание Руководства по публикациям. Кредит изображения: Советники по диссертациям

лет

Первоначальное издание представляло собой статью на семи страницах, которая характеризовалась как стандарт процедуры. Авторам было рекомендовано использовать заголовки, подзаголовки, отдельные разделы для введения, представления результатов исследования и обсуждения результатов, а также поддерживать логическую основу. В нем также содержатся инструкции о методе использования таблиц и о том, как цитировать используемые ссылки. С 1929 года стандарт процедур был разработан в книге под названием Руководство по публикации Американской Психологической Ассоциации, набор четко определенных предложений на основании требования студентов, исследователей и преподавателей по различным научным дисциплинам. Для пример, они добавили предложенные методы, чтобы избежать плагиата и самоуверенного словоблудия.

Стиль APA в настоящее время находится на 7-м уровне.th издание, вышедшее в 2019 году.

MLA от Ассоциации современного языка

MLA, сокращение от Modern Language Association, также является еще одним популярным форматом письма, используемым и признанным во всем мире. Такой стиль изложения Цель если быть кратким, но точным. Однако основное внимание в формате MLA уделяется цитатам.

Для цитирования в тексте в стиле MLA требуется указать фамилию автора и номер страницы цитируемой работы, и они не должны разделяться запятыми. В формате APA для текстовых ссылок необходимо указать фамилию автора, год и номер страницы, разделенные запятыми.

Формат MLA широко использует сокращения в текстах цитат, а иногда даже использует сноски. В конце документа также есть список ссылок с полными источниками. Метод цитирования, используемый в стиле MLA, особенно эффективен против плагиата. От автора требуется указать точное местонахождение своих источников, побуждая их на самом деле прочитать процитированные ими работы. Это также удерживает автора от цитирования недействительных источников. Обязательное использование этого руководства проявляет уважение другим писателям и художникам. Это также позволяет авторам получить полную оценку своей работы.

Другими примечательными характеристиками формата MLA являются то, что в нем нет титульной страницы, используются поля в один дюйм, двойной интервал между предложениями, заголовок с именем и номером страницы, а также использование шрифта Times New Roman в 12-точка.

Он в основном используется в области языка, гуманитарных наук, литературы и других дисциплин в области гуманитарных наук.

Краткая история стиля MLA

9-е издание Справочника по ВПП

9-е издание Справочника по ВПП. Кредит изображения: MLA Style через Twitter

Истоки стиля MLA восходят к раннему 1950s, когда Ассоциация современного языка опубликовала свое первое руководство по стилю с целью научить ученых, как готовить свои работы к публикации. Однако ученые обнаружили много разночтений и не смогли единогласно согласиться с руководящими принципами. К 1970 г. руководство было обновлено, и к 1977 г. вышло первое издание Справочник ГНД был опубликован. Справочник помогал не только ученым, но и студентам университетов надлежащим образом подготовить свои академические тексты. С каждым новым изданием страницы справочника увеличивались, поскольку в нем содержались обновленные предложения по форматированию и ссылкам.

Пособие по ВПП находится на 9 страницах.th издание, вышедшее в 2021 году.

CMS или Чикагское руководство по стилю

CMS или CMOS — это сокращение от Чикагского руководства по стилю. Это старейший и наиболее предпочтительный формат, используемый издателями как для академических, так и для неакадемических публикаций. Но поскольку мы обсуждаем стили академического письма, формат CMS в основном используется учеными и студентами, занимающимися литературой, историей, искусством и другими дисциплинами в области гуманитарных и естественных наук.

CMS довольно сложна по сравнению с другими стилями, но она также наиболее эстетична и удобна для чтения.

Наиболее примечательной особенностью CMS является то, что, в отличие от APA и MLA, она не использует цитирование в тексте. Это потому, что его издатели считают, что они мешают чтению. Вместо цитирования в тексте стиль CMS использования сноски и концевые сноски. Сноски появляются внизу страницы, а концевые сноски появляются в конце документа в нумерованном списке. Единственное, что должно появиться в тексте, — это номер, соответствующий сноске внизу страницы. Однако они настолько малы, что их легко игнорировать при чтении. В самом конце, как и все другие руководства по стилю, есть список ссылок с полными цитируемыми источниками. Этот метод приносит пользу читателю, сводя к минимуму отвлекающие факторы и отдает должное авторам источников, избегая плагиата.

Остальные особенности стиля CMS аналогичны двум другим стилям. Это использования стандартные шрифты, такие как Times New Roman или Arial размером 12 pt, с полями в 1 дюйм, двойным межстрочным интервалом и номерами страниц, размещенными вверху справа, как в APA или MLA, или внизу по центру страницы.

Хотя Википедия не является академическим источником, стиль ссылок, используемый в онлайн-энциклопедии, — это стиль CMS.

17-е издание Чикагского руководства по стилю

17-е издание Чикагского руководства по стилю. Кредит изображения: Википедия

Краткая история Чикагского руководства по стилю

лет

CMS — одно из старейших руководств по стилю в мире, определенно старше APA и MLA. Первоначальное руководство по стилю носило неформальный характер. Раньше академическая работа должна была пройти несколько этапов перед публикацией. Профессора сначала приносили свои рукописные рукописи к наборщикам в Чикагский университет Нажмите. Затем их передавали корректорам, которые исправляли и редактировали тексты, исправляя орфографические, синтаксические и грамматические ошибки. Именно здесь требуется наличие стандартного набора правил. Эти правила изначально были просто на листе, а к 1906 году они превратились в книгу, содержащую разработанные правила форматирования. Сегодня Чикаго Руководству по стилю уже 17 лет.th издание, вышедшее в 2017 году.

Другие форматы записи

Три руководства по стилю, рассмотренные выше, являются наиболее популярными. Мы видели, что APA, MLA и CMS используются в разных академических дисциплинах, но некоторые стили зарезервированы для конкретных дисциплин. Например, AP или Associated Press используются для журналистики. Газеты и журналы, особенно в США, склонны использовать этот формат. Стиль IEEE или Института инженеров по электротехнике и электронике используется для написания академических работ по техническим дисциплинам, таким как инженерия и информатика. Американская медицинская ассоциация или Руководство по стилю AMA используется для таких дисциплин, как медицина и здравоохранение. Синяя книга используется для оформления документов по юридическим дисциплинам, особенно в США. Список бесконечен.

В чем разница между всеми этими руководствами по стилю?

Руководства по стилю могут содержать очень подробные инструкции, поэтому есть правила стилизации вещей, которые нелегко придут в голову. Причина, по которой существует так много стилей, заключается в стандартизации способов представления информации. Необходимость в этом возникает из-за природа английского языка. Вот почему разные стили различаются, устанавливая стандарты для таких вещей, как использование заглавных букв в заголовках, заголовках, пунктуации, датах, числах, составных словах, акронимах, формате, словоблудии для названий брендов, групп людей и технологических устройств.

таблица, показывающая разницу между mla и apa

Изображение, показывающее некоторые различия между стилями APA и MLA. Кредит изображения: Центр PhD

Например, для справочного списка APA используется заголовок «Ссылки», MLA использует «Процитированные произведения», а CMS называет свой список ссылок «Библиография». В случае чисел эти стили определяют, когда должны использоваться числовые цифры, а когда числа должны быть написаны по буквам. Стили также стандартизируют способ написания дат; должны ли они следовать формату мм / дд / гггг или дд / мм / гггг. Они также определяют, произносится ли слово, например, газонокосилка, как «газонокосилка» или «газонокосилка».

Помимо этих различий, руководства по стилям также устанавливают правила форматирования, определения типа шрифта и разрешенных размеров шрифта, межстрочного интервала, отступов, полей, верхних и нижних колонтитулов, номеров страниц и т. Д.

Однако наиболее заметным и значительным различием между разными стилями будет способ цитирования источников. Каждое руководство по стилю имеет свой собственный способ использования цитат в тексте и цитирования в списках литературы. Как мы видели ранее, некоторые используют фамилию и год автора, разделенные запятыми в круглых скобках, другие не используют запятые и используют номер страницы источника вместо года публикации источника.

В чем смысл использования руководств по стилю?

Теперь, когда мы немного более знакомы с руководствами по стилю и их использованием, давайте разберемся с некоторыми причинами, по которым они используются:

  • Форматирование в этом случае помогает выделить контент таким образом, чтобы читатель мог написать огромное количество текста. Таким образом, информация становится более понятной и понятной. Структурирование также помогает читателям быстро определить и найти очень конкретную тему, которую они могут искать. Возможность достичь этого будет соответствовать самой цели публикации академической литературы, которая заключается в понимании фактов, представленных доказательствами, оспаривании существующих теорий и исследований и глубоком анализе тем.
  • Стили также помогают поддерживать последовательность, позволяя читателю быстрее интерпретировать информацию и избегать недоразумений.
  • Они разрешают идеи течь ясно, точно и последовательно, обеспечивая сохранение логической структуры и рамок даже в больших частях письменной работы.
  • Наличие установленного свода правил относительно формата письменной работы экономит время и силы. Необходимость думать о том, как отформатировать и представить информацию, отнимет время и силы, которые теперь можно использовать для работы над содержанием.
  • Умение применять эти рекомендации показывает, что человек способен следовать правилам и инструкции. Это особенно касается студентов университетов, поскольку демонстрация этой способности может повлиять на вероятность приема на работу.
  • Руководства по стилю помогают поддерживать академическую честность, отдавая должное должным образом. Указание цитируемых работ повышает доверие к работе и автору. Если эти работы не цитируются, это будет означать, что контент является плагиатом. Плагиат снижает доверие к автору и снижает вероятность публикации в будущем. Для студентов это может результат в низких оценках или дисквалификации. Плагиат в целом наказывается.

красный кружок перечеркивает плагиат

Изображение Фото: Копирайтинг Big Star

лет

Краткое изложение постоянно развивающихся руководств по стилю

В этом посте мы узнали, что руководства по стилю — это, по сути, набор предложений или руководств, разработанных различными организациями, ассоциациями и издателями, которые позволяют академическим авторам эффективно представлять свой контент. Среди многих причин они используются для обеспечения согласованности, предотвращения плагиата и облегчения понимания исследования. Мы увидели, что три самых популярных руководства по стилю — это стили APA, MLA и CMS. Эти руководящие принципы постоянно разрабатываются и обновляются в своих выпусках руководств для приспособиться к изменениям вызвано достижениями в области технологий. В настоящее время можно даже цитировать фильмы, видео на YouTube и другие сообщения в социальных сетях.

Не стесняйтесь делиться своими мыслями в комментариях ниже.

Щелкните здесь, чтобы увидеть больше подобных статей.

лет

Понравилась статья? Поделить с друзьями:
  • Габапентин 300 инструкция для собак дозировка
  • Набор лего майнкрафт пчелиная ферма инструкция
  • Держатель для телефона в машину deppa инструкция
  • Сбербанк центральный аппарат руководство
  • Пит уокер комплексное птср руководство по восстановлению от детской травмы читать онлайн бесплатно