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

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:

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]

References[edit]

External links[edit]

Style guide definition is given as a set of standards and rules for the design, writing, and formatting of paperwork. A style guide acts as a tool that indicates your brand identity and company information to your workers and vendors who will be responsible for creating content for your organization. It also helps with the consistency in grammar, spelling, and terminology of your documents, presentations, and advertorials, etc. Whether it is a content style guide, a translation style guide, or a corporate style guide, there are several main rules that you should pay attention to while creating a style guide for your company.

What Should Be Included in a Brand Style Guide?

The most important thing is, your style guide shouldn’t be too long or boring for the translator. It should be easily understandable and written with simple words. Also, style guides should be special to the brand and should reflect the characteristics of the company. You have to remember that the world is steadily turning every day. Thus, changes in the company, in the products, or the target market are inevitable. For this exact reason the style guide should not be static; every piece of information and every directive should be easily updatable. Then, what do we need while creating a company style guide?

The translator should know about your company, so implementing a short description of the company, its purpose and mission are a good starting point for building a brand style guide template. The global market is the melting pot of all different countries and cultures. That’s why different company style guides should be prepared according to the consuming habits of the different markets.

It is important to catch the right tone and format during the translation process. So the translator will be informed about the target market, target audience, and the purpose of the product. You can attach some visuals or even audio files or video links that are related to previous translations done by different translators to the product style guide.

Editors are responsible for the most critical part of the translation process; the last control before the project delivered to the customer. Since translators can miss some points during a potentially long and tiring translation process, the editors have to have further information about the company and the product within the editorial style guides.

Why is It Important to Have A Style Guide?

So what is a style guide and why is it important? A style guide is like the ID Card of a company. It makes sure whatever content you produce, it stays within your lines. Companies invest a lot of time and energy into building their brand, and style guides let you protect it. Writing style guide might seem like an extra effort in the beginning but it helps you save more time in the long run. Let’s see some of the main reasons a company should have a style guide.

Consistency
We can’t stress this one enough- keeping consistency is the main purpose of a style guide. Companies publish their content on different channels, in various countries, during different time periods, via different service providers. How do you make sure that you choose the same words each time you send out a text to the void of the internet, while there are different people working on each text? With the help of a style guide of course. There are a variety of ways to say one thing. But having a style guide will let the team in charge know your preferences. It could be leaving all dates in the US format or writing your company name with lowercase letters only, or never using semicolons. You name it, we make it! It will also prevent confusion that could arise out of the dual-naming of some concepts.

Branding
As we have mentioned a while ago, visual style guides preserve the way your company looks. By that we mean, your graphics will stay the same on every platform. Your logo will be the same size with the exact shade of red, the spacing between the lines will always be the same and if you only want to use Comic Sans as your font -we hope not- no one can stop you!

Using the Right Words
Specific words could be inappropriate to use in some cultures despite looking fairly neutral. But your newly hired content strategist might not be familiar with the specific culture. By having a set style guide, you’re not leaving any risk of sounding offensive in any region you’re addressing.

Setting the Tone
The thing that goes into what forms a brand apart from the way it looks is how it sounds. Nike, an active sportswear brand, for example, sounds excited and motivating in its advertisements whereas UPS Global, a logistics company, wants to focus on a feeling of safety and trust so the texts will sound calmer. These are not left up to chance and are all ensured with editorial style guides.

Saving Time
The last point that shows the importance of a style guide is realizing how much time it’s going to save you in the long run. Having these points listed in a style guide will make sure it’s accessible any time it’s needed. It will prevent thousands of repetitive conversations among your team members and they will have more time to focus on what really matters. You won’t have to worry about maintaining the image of your brand.

How to Create a Style Guide That Fits You the Best

When an organization thinks about designing a style guide, certain aspects of the guide needs to be clarified and also approved by all involved parties in the organization. Getting approval from all stakeholders is important since it will be followed when it is published and updated, or at least increases the chance of being followed.

How to make a style guide? You will have to pay particular attention to multiple aspects of the specific needs of your target audience. First, know your audience! You may have target clients within a specific age group that will attribute certain meanings to some words or phrases while other age groups have different meanings in their minds. Think of Millennials vs Baby Boomers as two groups of your target audience and you can test many differences in their perceptions and understandings. Sam rule applies to different geographies due to cultural differences.

Second, you need to think very carefully about your company and brand values. Once you decide on that you will know how your brand needs to come across to your audience.

Third, perhaps more importantly, you don’t have to reinvent the wheel. All you need to do is to look at your competitors’ communication style, not to replicate it or plagiarise from it but to analyze it. You may conclude that your competitors have already created a jargon that resonates with your audience. We just wanted to give you a few things to consider before developing your style guide here, and there are of course, more to it.

You are now ready to develop your style guide. Creating a style guide will require you to think hard about what should be included in it and the key elements that make up your guide. Here is what we think you should consider as the key elements: Voice, Tone, Style, and Layout.

Voice: One of the most important elements is the voice as it will set the basis for the rest of your style guide. You have to decide how your brand should be perceived by your audience — do you want to sound funny or serious, formal or personable? This voice will help you set your unique personality in communicating with your audience.

Tone: If you are a writer, your voice will always be the same voice but your tone will change when you write for different channels. For example, you may write differently for a social media post but your tone may sound different when you are writing a scientific paper. A cheerful consideration should be given to your tone in your style guide and define it accordingly.

Style: This is where you standardize your style guide for the way content creators must follow in terms of punctuations, abbreviations, use of emojis or not, time and date formats, etc.

Layout: Last but not least, you should decide on the layout options of your style guide. This is where you decide on the use of layout elements such as how the images should look, color schema, the use of fonts, links, and lists, etc.

There are many style guide examples online, which you should take advantage of. You may begin with a style guide template to make your job easier. Similarly, there are many brand style guide examples and they are at your fingertips with a few google searches. Your style guide is a living document that needs to be constantly updated but it does not need to be a hefty document.

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

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

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

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

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

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

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

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

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

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

• Обложка
• Содержание
• Введение
• Дизайн логотипа
  • Знакомство с логотипом
  • Использование логотипа
  • Элементы логотипа
  • Охранное поле
  • Недопустимое использование логотипа
• Система корпоративных цветов
  • Корпоративные цвета
  • Основной цвет
  • Система вторичных цветов
• Корпоративная типографика
  • Корпоративные шрифты
  • Основной шрифт
  • Дополнительный шрифт
  • Иерархия шрифтов
• Корпоративная иконографика
• Сеточные системы (grid systems)
  • Сеточная система для печатных материалов
  • Размещение логотипа
  • Колонки и отступы
  • Вертикальная сеточная система для планшетов
• Изображения и режимы наложения (blending modes)
  • Стиль корпоративных изображений
  • Цвета корпоративных изображений
  • Черно-белые корпоративные изображения
  • Режимы наложения и варианты
  • Сеточные системы для изображений
• Презентации и другие печатные материалы
• Заключение

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

06-04-2022

1С: Руководство по стилю оформления

Почти все убеждены, что любой стиль кроме их собственного ужасен и нечитаем. Уберите отсюда «кроме их собственного» — и они будут, наверное, правы…

— Джерри Коффин (Jerry Coffin) об отступах

Оформление модулей

• Длина строки в общем случае не должна превышать 120 символов.
• Для отступов необходимо использовать символы табуляции.
• Одна строка кода — одна управляющая конструкция.

// Плохо:
Если ЭтоБрак Тогда Продолжить; КонецЕсли;

// Хорошо:
Если ЭтоБрак Тогда
  Продолжить;
КонецЕсли;

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

// Плохо:
Сообщить(“Сумма: “+Сумма);

// Хорошо:
Сообщить(“Сумма: “ + Сумма);

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

// Начальное состояние (строка слишком длинная):
НалоговыйУчет.ОстаткиВременныхРазниц(СтрокаВидАктиваОбязательства, СписокОрганизаций, Реквизиты.НачалоГода, Реквизиты.КонДата);

// Плохо:
НалоговыйУчет.ОстаткиВременныхРазниц(
    СтрокаВидАктиваОбязательства, СписокОрганизаций, Реквизиты.НачалоГода, Реквизиты.КонДата);

// Лучше:
НалоговыйУчет.ОстаткиВременныхРазниц(СтрокаВидАктиваОбязательства,
                                     СписокОрганизаций,
                                     Реквизиты.НачалоГода,
                                     Реквизиты.КонДата);

// Хорошо:
НалоговыйУчет.ОстаткиВременныхРазниц(
    СтрокаВидАктиваОбязательства,
    СписокОрганизаций,
    Реквизиты.НачалоГода,
    Реквизиты.КонДата);
    

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

// Хорошо:
НоваяСтрока = ВидыОпераций.Добавить();
НоваяСтрока.ВидОперации         = ВидОперации;
НоваяСтрока.НомерГруппы         = ГруппаПоВидуОперации(ВидОперации);
НоваяСтрока.ПоОрганизацииВЦелом = ГруппаПоОрганизации(НоваяСтрок);

Методы

• Параметр функции не должен возвращать значение. Иными словами не используйте входные параметры функций как дополнительный вывод. Весь вывод должен быть в возвращаемом значении. Если нужно возвращать несколько значений следует использовать такие типы как Структура, Массив и т.д.

// Плохо:
URLСервиса = "";
ИмяПользователя = "";
ПарольПользователя = "";

ЗаполнитьПараметрыПодключения(URLСервиса, ИмяПользователя, Пароль);

// Хорошо:
ПараметрыПодключения = ПолучитьПараметрыПодключения();
// Возвращаемое значение - структура:
//     URLСервиса         - Строка
//     ИмяПользователя    - Строка
//     ПарольПользователя - Строка

Условия

• Предпочтительней использовать тернарный оператор для простых конструкций.

// Плохо:
Если НДС0 Тогда
    Возврат 0;
Иначе
    Возврат 18;
КонецЕсли;

// Хорошо:
Возврат ?(НДС0, 0, 18);

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

// Плохо:
Если ИдентификаторОбъекта = "АнализСубконто"
    ИЛИ ИдентификаторОбъекта = "АнализСчета"
    ИЛИ ИдентификаторОбъекта = "ОборотноСальдоваяВедомость"
    ИЛИ ИдентификаторОбъекта = "ОборотноСальдоваяВедомостьПоСчету"
    ИЛИ ИдентификаторОбъекта = "ОборотыМеждуСубконто"
    ИЛИ ИдентификаторОбъекта = "ОборотыСчета"
    ИЛИ ИдентификаторОбъекта = "СводныеПроводки" 
    ИЛИ ИдентификаторОбъекта = "ГлавнаяКнига"
    ИЛИ ИдентификаторОбъекта = "ШахматнаяВедомость" Тогда
    ПараметрыРасшифровки.Вставить("ОткрытьОбъект", Ложь);
		
    ЕстьПоказатель  = Ложь;
    ЕстьКорЗначение = Ложь;
    ЕстьСчет        = Истина;
    Счет            = Неопределено;
    ПервыйЭлемент   = Неопределено;
КонецЕсли;

// Хорошо:
Если ОткрыватьОбъектПриИдентификаторе(ИдентификаторОбъекта) Тогда
    ПараметрыРасшифровки.Вставить("ОткрытьОбъект", Ложь);
		
    ЕстьПоказатель  = Ложь;
    ЕстьКорЗначение = Ложь;
    ЕстьСчет        = Истина;
    Счет            = Неопределено;
    ПервыйЭлемент   = Неопределено;
КонецЕсли;

Функция ОткрыватьОбъектПриИдентификаторе(ИдентификаторОбъекта)
	
    Возврат ИдентификаторОбъекта = "АнализСубконто"
        ИЛИ ИдентификаторОбъекта = "АнализСчета"
        ИЛИ ИдентификаторОбъекта = "ОборотноСальдоваяВедомость"
        ИЛИ ИдентификаторОбъекта = "ОборотноСальдоваяВедомостьПоСчету"
        ИЛИ ИдентификаторОбъекта = "ОборотыМеждуСубконто"
        ИЛИ ИдентификаторОбъекта = "ОборотыСчета"
        ИЛИ ИдентификаторОбъекта = "СводныеПроводки" 
        ИЛИ ИдентификаторОбъекта = "ГлавнаяКнига"
        ИЛИ ИдентификаторОбъекта = "ШахматнаяВедомость";

КонецФункции

• Избегайте использование Йода-синтаксиса.

// Плохо:
Если 0 = Сумма Тогда

// Хорошо:
Если Сумма = 0 Тогда

Переменные

• Избегайте неявного определения переменных

// Плохо
Функция ИдентификаторОбъекта(Объект)
    // Ошибки не будет, даже если переменная не определена в области видимости.
    // В результате будет определена переменная со значением Неопределено.
    ВашаПеременная = ВашаПеременная;
    
    Если Не ЗначениеЗаполнено(ВашаПеременная) Тогда
        ...
    КонецЕсли;
КонецФункции

// Хорошо
Функция ИдентификаторОбъекта(Объект)
    Перем ВашаПеременная;
    ...
КонецФункции

Имена процедур, функций, переменных

• Следуюйте общему подходу именования

// Плохо:
этобрак, ЭТОБРАК, этоБрак

// Хорошо:
ЭтоБрак

• Не используйте отрицание в именах переменных и методов

// Плохо:
Функция ПроверкаНеПройдена()
...

Если Не (Условие И Не ПроверкаНеПройдена()) Тогда

// Хорошо:
Функция ПроверкаПройдена()
...

Если Не Условие И Не ПроверкаПройдена() Тогда

Комментарии

• Если код требует комментария для пояснения работы — в первую очередь необходимо рассмотреть варианты рефакторинга, чтобы код не требовал комментария.
• К комментариям также относятся ограничения на длину строки в 120 символов.

Создание, изменение объектов метаданных

• Если составной тип используется многократно, следует использовать объект конфигурации «Определяемый тип». Пример: «Документ резервирования», «Документ партии».