🔍 Начните печатать, чтобы искать по книге или перейти к нужной странице по номеру

Удобно листать не только прокруткой, но и клавишами‑стрелками:

 
между важными местами
Shift
между
разворотами
Мак­сим Илья­хов

Информационный стиль

Изда­тель­ство Бюро Гор­бу­нова
2016
Максим Ильяхов

Информационный стиль

Издательство Бюро Горбунова
2016
удк 811.161.1
ббк 81.2Рус‑2
И49
Илья­хов М. О.
И49
Инфор­ма­ци­он­ный стиль. —
М.: Изд‑во Бюро Гор­бу­нова, 2016
ISBN 978‑5‑9907024‑2‑4

Пред­став­ляем прак­ти­че­ское руко­вод­ство по редак­туре тек­ста в инфор­ма­ци­он­ном стиле. Учеб­ник пред­на­зна­чен для писа­те­лей, редак­то­ров, дизай­не­ров, раз­ра­бот­чи­ков и менеджеров.

УДК 811.161.1
ББК 81.2Рус‑2

Оглавление

удк 811.161.1
ббк 81.2Рус‑2
И49
И49
Ильяхов М. О.
Информационный стиль. —
М.: Изд‑во Бюро Горбунова, 2016
ISBN 978‑5‑9907024‑2‑4

Представляем практическое руководство по редактуре текста в информационном стиле. Учебник предназначен для писателей, редакторов, дизайнеров, разработчиков и менеджеров.

УДК 811.161.1
ББК 81.2Рус‑2

Оглавление

Скрыто 153 разворота

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

Три месяца я рабо­таю в ковор­кинге на шестом этаже тор­го­вого цен­тра. Уже осво­ился и готов поде­литься впечатлениями.

В ковор­кинге рабо­та­ется нена­много про­дук­тив­нее, чем дома. Я больше не отвле­ка­юсь на обще­ние с женой, но по‑преж­нему сижу в Фейс­буке. Колос­саль­ного при­ро­ста эффек­тив­но­сти я не заметил.

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

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

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

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

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

Три месяца я рабо­таю в ковор­кинге на шестом этаже тор­го­вого цен­тра. Уже осво­ился и готов поде­литься впечатлениями.

В ковор­кинге рабо­та­ется нена­много про­дук­тив­нее, чем дома. Я больше не отвле­ка­юсь на обще­ние с женой, но по‑преж­нему сижу в Фейс­буке. Колос­саль­ного при­ро­ста эффек­тив­но­сти я не заметил.

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

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

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

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

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

Три месяца я рабо­таю в ковор­кинге на шестом этаже тор­го­вого цен­тра. Уже осво­ился и готов поде­литься впечатлениями.

В ковор­кинге рабо­та­ется нена­много про­дук­тив­нее, чем дома. Я больше не отвле­ка­юсь на обще­ние с женой, но по‑преж­нему сижу в Фейс­буке. Колос­саль­ного при­ро­ста эффек­тив­но­сти я не заметил.

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

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

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

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

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

Три месяца я рабо­таю в ковор­кинге на шестом этаже тор­го­вого цен­тра. Уже осво­ился и готов поде­литься впечатлениями.

В ковор­кинге рабо­та­ется нена­много про­дук­тив­нее, чем дома. Я больше не отвле­ка­юсь на обще­ние с женой, но по‑преж­нему сижу в Фейс­буке. Колос­саль­ного при­ро­ста эффек­тив­но­сти я не заметил.

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

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

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

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

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

Три месяца я рабо­таю в ковор­кинге на шестом этаже тор­го­вого цен­тра. Уже осво­ился и готов поде­литься впечатлениями.

В ковор­кинге рабо­та­ется нена­много про­дук­тив­нее, чем дома. Я больше не отвле­ка­юсь на обще­ние с женой, но по‑преж­нему сижу в Фейс­буке. Колос­саль­ного при­ро­ста эффек­тив­но­сти я не заметил.

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

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

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

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

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

В ковор­кинге рабо­та­ется нена­много про­дук­тив­нее, чем дома. Я больше не отвле­ка­юсь на обще­ние с женой, но по‑преж­нему сижу в Фейс­буке. Колос­саль­ного при­ро­ста эффек­тив­но­сти я не заметил.

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

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

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

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

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

Три месяца я рабо­таю в ковор­кинге на шестом этаже тор­го­вого цен­тра. Уже осво­ился и готов поде­литься впечатлениями.

В ковор­кинге рабо­та­ется нена­много про­дук­тив­нее, чем дома. Я больше не отвле­ка­юсь на обще­ние с женой, но по‑преж­нему сижу в Фейс­буке. Колос­саль­ного при­ро­ста эффек­тив­но­сти я не заметил.

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

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

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

Последовательность. Текст выстроен последовательно:

  • вве­де­ние объ­яс­няет ситу­а­цию: о ком речь, что про­ис­хо­дит, чему посвя­щён текст;

  • основ­ная часть рас­кры­вает тему текста;

  • в заклю­че­нии — вывод, кото­рый под­во­дит итог, стоит ли рабо­тать в коворкинге.

Такая кон­струк­ция смот­рится есте­ственно и не вызы­вает вопро­сов. Чита­тель не заме­чает, что перед ним вве­де­ние, основ­ная часть и заключение.

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

Без заклю­че­ния текст пока­жется неокон­чен­ным. А если читать невни­ма­тельно, то по заклю­че­нию чита­тель поду­мает, что весь текст был посвя­щён еде и посуде.

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

Три месяца я работаю в коворкинге на шестом этаже торгового центра. Уже освоился и готов поделиться впечатлениями.

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

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

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

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

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

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

Три месяца я работаю в коворкинге на шестом этаже торгового центра. Уже освоился и готов поделиться впечатлениями.

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

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

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

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

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

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

Три месяца я работаю в коворкинге на шестом этаже торгового центра. Уже освоился и готов поделиться впечатлениями.

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

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

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

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

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

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

Три месяца я работаю в коворкинге на шестом этаже торгового центра. Уже освоился и готов поделиться впечатлениями.

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

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

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

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

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

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

Три месяца я работаю в коворкинге на шестом этаже торгового центра. Уже освоился и готов поделиться впечатлениями.

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

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

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

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

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

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

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

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

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

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

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

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

Три месяца я работаю в коворкинге на шестом этаже торгового центра. Уже освоился и готов поделиться впечатлениями.

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

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

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

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

Последовательность. Текст выстроен последовательно:

  • введение объясняет ситуацию: о ком речь, что происходит, чему посвящён текст;

  • основная часть раскрывает тему текста;

  • в заключении — вывод, который подводит итог, стоит ли работать в коворкинге.

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

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

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

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

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

Сами абзацы тоже плохо струк­ту­ри­ро­ваны: где‑то они начи­на­ются с клю­че­вых слов, будто это под­за­го­ловки; где‑то — с пове­ли­тель­ного наклонения.

Попро­буем при­ве­сти этот мани­фест в порядок.

Прин­ципы оформ­ле­ния кода

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

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

Пустые строки. Функ­ции верх­него уровня и опре­де­ле­ния клас­сов отби­ва­ются двумя пустыми стро­ками. Методы внутри класса отби­ва­ются одной пустой стро­кой. Исполь­зуйте пустые строки экономно.

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

Лиш­ние про­белы — внутри ско­бок, перед запя­той, точ­кой с запя­тойли двое­то­чия. Про­белы нужны вокруг операторов.

Прин­ципы оформ­ле­ния кода

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

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

Пустые строки. Функ­ции верх­него уровня и опре­де­ле­ния клас­сов отби­ва­ются двумя пустыми стро­ками. Методы внутри класса отби­ва­ются одной пустой стро­кой. Исполь­зуйте пустые строки экономно.

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

Лиш­ние про­белы — внутри ско­бок, перед запя­той, точ­кой с запя­тойли двое­то­чия. Про­белы нужны вокруг операторов.

Прин­ципы оформ­ле­ния кода

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

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

Пустые строки. Функ­ции верх­него уровня и опре­де­ле­ния клас­сов отби­ва­ются двумя пустыми стро­ками. Методы внутри класса отби­ва­ются одной пустой стро­кой. Исполь­зуйте пустые строки экономно.

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

Лиш­ние про­белы — внутри ско­бок, перед запя­той, точ­кой с запя­тойли двое­то­чия. Про­белы нужны вокруг операторов.

Прин­ципы оформ­ле­ния кода

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

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

Пустые строки. Функ­ции верх­него уровня и опре­де­ле­ния клас­сов отби­ва­ются двумя пустыми стро­ками. Методы внутри класса отби­ва­ются одной пустой стро­кой. Исполь­зуйте пустые строки экономно.

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

Лиш­ние про­белы — внутри ско­бок, перед запя­той, точ­кой с запя­тойли двое­то­чия. Про­белы нужны вокруг операторов.

Прин­ципы оформ­ле­ния кода

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

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

Пустые строки. Функ­ции верх­него уровня и опре­де­ле­ния клас­сов отби­ва­ются двумя пустыми стро­ками. Методы внутри класса отби­ва­ются одной пустой стро­кой. Исполь­зуйте пустые строки экономно.

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

Лиш­ние про­белы — внутри ско­бок, перед запя­той, точ­кой с запя­тойли двое­то­чия. Про­белы нужны вокруг операторов.

Прин­ципы оформ­ле­ния кода

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

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

Пустые строки. Функ­ции верх­него уровня и опре­де­ле­ния клас­сов отби­ва­ются двумя пустыми стро­ками. Методы внутри класса отби­ва­ются одной пустой стро­кой. Исполь­зуйте пустые строки экономно.

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

Лиш­ние про­белы — внутри ско­бок, перед запя­той, точ­кой с запя­тойли двое­то­чия. Про­белы нужны вокруг операторов.

Принципы оформления кода

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

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

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

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

Лишние пробелы — внутри скобок, перед запятой, точкой с запятойли двоеточия. Пробелы нужны вокруг операторов.

Принципы оформления кода

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

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

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

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

Лишние пробелы — внутри скобок, перед запятой, точкой с запятойли двоеточия. Пробелы нужны вокруг операторов.

Принципы оформления кода

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

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

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

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

Лишние пробелы — внутри скобок, перед запятой, точкой с запятойли двоеточия. Пробелы нужны вокруг операторов.

Принципы оформления кода

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

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

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

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

Лишние пробелы — внутри скобок, перед запятой, точкой с запятойли двоеточия. Пробелы нужны вокруг операторов.

Принципы оформления кода

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

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

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

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

Лишние пробелы — внутри скобок, перед запятой, точкой с запятойли двоеточия. Пробелы нужны вокруг операторов.

Принципы оформления кода

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

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

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

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

Лишние пробелы — внутри скобок, перед запятой, точкой с запятойли двоеточия. Пробелы нужны вокруг операторов.

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

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

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

Попробуем привести этот манифест в порядок.

Чтобы при­ве­сти в поря­док этот текст, возь­мём за основу еди­ную струк­туру для каж­дого правила:

Прин­цип — утверждение

Реко­мен­да­ция — пове­ли­тель­ное наклонение

Объ­яс­не­ние — в сво­бод­ной форме, по желанию

При­ме­ним струк­туру к пер­вому абзацу тек­ста: прин­цип, реко­мен­да­ция, объяснение.

Рас­про­стра­ним на все абзацы.

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

Пер­вый вари­ант — пре­вра­тить все прин­ципы в выра­же­ния с гла­го­лом в неопре­де­лён­ной форме. Полу­ча­ется что‑то вроде сове­тов, но не везде это выгля­дит элегантно.

Дру­гой вари­ант — обо­зна­чить, о чём пра­вило. Выгля­дит элегантнее.

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

Теперь все пра­вила орга­ни­зо­ваны единообразно:

Клю­че­вое слово — существительное

Совет — пове­ли­тель­ное наклонение

Исклю­че­ние — пове­ли­тель­ное наклонение

Объ­яс­не­ние — в сво­бод­ной форме, по желанию

Прин­ципы оформ­ле­ния кода

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

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

Пустые строки. Функ­ции верх­него уровня и опре­де­ле­ния клас­сов отби­ва­ются двумя пустыми стро­ками. Методы внутри класса отби­ва­ются одной пустой стро­кой. Исполь­зуйте пустые строки экономно.

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

Лиш­ние про­белы — внутри ско­бок, перед запя­той, точ­кой с запя­той или двое­то­чия. Про­белы нужны вокруг операторов.

Прин­ципы оформ­ле­ния кода

Чита­е­мость важна. Пишите код так, чтобы его было удобно читать незна­ко­мым людям. Код читают чаще, чем пишут.

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

Пустые строки. Функ­ции верх­него уровня и опре­де­ле­ния клас­сов отби­ва­ются двумя пустыми стро­ками. Методы внутри класса отби­ва­ются одной пустой стро­кой. Исполь­зуйте пустые строки экономно.

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

Лиш­ние про­белы — внутри ско­бок, перед запя­той, точ­кой с запя­той или двое­то­чия. Про­белы нужны вокруг операторов.

Прин­ципы оформ­ле­ния кода

Чита­е­мость важна. Пишите код так, чтобы его было удобно читать незна­ко­мым людям. Код читают чаще, чем пишут.

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

Пустые строки. Функ­ции верх­него уровня и опре­де­ле­ния клас­сов отби­ва­ются двумя пустыми стро­ками. Методы внутри класса отби­ва­ются одной пустой стро­кой. Исполь­зуйте пустые строки экономно.

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

Лиш­ние про­белы — внутри ско­бок, перед запя­той, точ­кой с запя­той или двое­то­чия. Про­белы нужны вокруг операторов.

Прин­ципы оформ­ле­ния кода

Чита­е­мость важна. Пишите код так, чтобы его было удобно читать незна­ко­мым людям. Код читают чаще, чем пишут.

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

Пустые строки. Функ­ции верх­него уровня и опре­де­ле­ния клас­сов отби­ва­ются двумя пустыми стро­ками. Методы внутри класса отби­ва­ются одной пустой стро­кой. Исполь­зуйте пустые строки экономно.

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

Лиш­ние про­белы — внутри ско­бок, перед запя­той, точ­кой с запя­той или двое­то­чия. Про­белы нужны вокруг операторов.

Прин­ципы оформ­ле­ния кода

Чита­е­мость важна. Пишите код так, чтобы его было удобно читать незна­ко­мым людям. Код читают чаще, чем пишут.

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

Пустые строки. Функ­ции верх­него уровня и опре­де­ле­ния клас­сов отби­ва­ются двумя пустыми стро­ками. Методы внутри класса отби­ва­ются одной пустой стро­кой. Исполь­зуйте пустые строки экономно.

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

Лиш­ние про­белы — внутри ско­бок, перед запя­той, точ­кой с запя­той или двое­то­чия. Про­белы нужны вокруг операторов.

Прин­ципы оформ­ле­ния кода

Чита­е­мость важна. Пишите код так, чтобы его было удобно читать незна­ко­мым людям. Код читают чаще, чем пишут.

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

Эко­но­мить пустые строки. Функ­ции верх­него уровня и опре­де­ле­ния клас­сов отби­вайте двумя пустыми стро­ками, методы внутри класса — одной. Пустые строки — инстру­мент смыс­ло­вого деле­ния кода.

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

Сле­дить за про­бе­лами. Не ставьте про­белы внутри ско­бок, перед запя­той, точ­кой с запя­той или двое­то­чия; ставьте — вокруг опе­ра­то­ров. Про­белы должны исполь­зо­ваться последовательно.

Прин­ципы оформ­ле­ния кода

Чита­е­мость важна. Пишите код так, чтобы его было удобно читать незна­ко­мым людям. Код читают чаще, чем пишут.

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

Эко­но­мить пустые строки. Функ­ции верх­него уровня и опре­де­ле­ния клас­сов отби­вайте двумя пустыми стро­ками, методы внутри класса — одной. Пустые строки — инстру­мент смыс­ло­вого деле­ния кода.

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

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

Прин­ципы оформ­ле­ния кода

Сле­дить за чита­е­мо­стью. Пишите код так, чтобы его было удобно читать незна­ко­мым людям. Код читают чаще, чем пишут.

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

Эко­но­мить пустые строки. Функ­ции верх­него уровня и опре­де­ле­ния клас­сов отби­вайте двумя пустыми стро­ками, методы внутри класса — одной. Пустые строки — инстру­мент смыс­ло­вого деле­ния кода.

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

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

Прин­ципы оформ­ле­ния кода

Чита­е­мость. Пишите код так, чтобы его было удобно читать незна­ко­мым людям. Код читают чаще, чем пишут.

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

Пустые строки. Функ­ции верх­него уровня и опре­де­ле­ния клас­сов отби­вайте двумя пустыми стро­ками, методы внутри класса — одной. Пустые строки — инстру­мент смыс­ло­вого деле­ния кода.

Кавычки. Для строк выбе­рите оди­нар­ные или двой­ные кавычки и исполь­зуйте после­до­ва­тельно. Если у вас стоит выбор, сме­нить фор­мат кавы­чек или экра­ни­ро­вать кавычки внутри строки, сме­ните фор­мат: экра­ни­ро­ва­ние хуже читается.

Про­белы. Не ставьте внутри ско­бок, перед запя­той, точ­кой с запя­тойли двое­то­чия; ставьте вокруг опе­ра­то­ров. Про­белы должны исполь­зо­ваться последовательно.

Прин­ципы оформ­ле­ния кода

Чита­е­мость. Пишите код так, чтобы его было удобно читать незна­ко­мым людям. Код читают чаще, чем пишут.

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

Пустые строки. Функ­ции верх­него уровня и опре­де­ле­ния клас­сов отби­вайте двумя пустыми стро­ками, методы внутри класса — одной. Пустые строки — инстру­мент смыс­ло­вого деле­ния кода.

Кавычки. Для строк выбе­рите оди­нар­ные или двой­ные кавычки и исполь­зуйте после­до­ва­тельно. Если у вас стоит выбор, сме­нить фор­мат кавы­чек или экра­ни­ро­вать кавычки внутри строки, сме­ните фор­мат: экра­ни­ро­ва­ние хуже читается.

Про­белы. Не ставьте про­белы внутри ско­бок, перед запя­той, точ­кой с запя­той или двое­то­чия; ставьте вокруг опе­ра­то­ров. Про­белы должны исполь­зо­ваться последовательно.

Прин­ципы оформ­ле­ния кода

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

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

Пустые строки. Функ­ции верх­него уровня и опре­де­ле­ния клас­сов отби­вайте двумя пустыми стро­ками, методы внутри класса — одной. В край­нем слу­чае отби­вайте смыс­ло­вые блоки функ­ций двумя стро­ками. Пустые строки — инстру­мент смыс­ло­вого деле­ния кода.

Кавычки. Для строк выбе­рите оди­нар­ные или двой­ные кавычки и исполь­зуйте после­до­ва­тельно. Если у вас стоит выбор, сме­нить фор­мат кавы­чек или экра­ни­ро­вать кавычки внутри строки, сме­ните фор­мат: экра­ни­ро­ва­ние хуже читается.

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

Принципы оформления кода

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

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

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

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

Лишние пробелы — внутри скобок, перед запятой, точкой с запятой или двоеточия. Пробелы нужны вокруг операторов.

Принципы оформления кода

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

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

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

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

Лишние пробелы — внутри скобок, перед запятой, точкой с запятой или двоеточия. Пробелы нужны вокруг операторов.

Принципы оформления кода

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

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

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

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

Лишние пробелы — внутри скобок, перед запятой, точкой с запятой или двоеточия. Пробелы нужны вокруг операторов.

Принципы оформления кода

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

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

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

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

Лишние пробелы — внутри скобок, перед запятой, точкой с запятой или двоеточия. Пробелы нужны вокруг операторов.

Принципы оформления кода

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

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

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

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

Лишние пробелы — внутри скобок, перед запятой, точкой с запятой или двоеточия. Пробелы нужны вокруг операторов.

Принципы оформления кода

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

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

Экономить пустые строки. Функции верхнего уровня и определения классов отбивайте двумя пустыми строками, методы внутри класса — одной. Пустые строки — инструмент смыслового деления кода.

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

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

Принципы оформления кода

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

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

Экономить пустые строки. Функции верхнего уровня и определения классов отбивайте двумя пустыми строками, методы внутри класса — одной. Пустые строки — инструмент смыслового деления кода.

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

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

Принципы оформления кода

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

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

Экономить пустые строки. Функции верхнего уровня и определения классов отбивайте двумя пустыми строками, методы внутри класса — одной. Пустые строки — инструмент смыслового деления кода.

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

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

Принципы оформления кода

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

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

Пустые строки. Функции верхнего уровня и определения классов отбивайте двумя пустыми строками, методы внутри класса — одной. Пустые строки — инструмент смыслового деления кода.

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

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

Принципы оформления кода

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

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

Пустые строки. Функции верхнего уровня и определения классов отбивайте двумя пустыми строками, методы внутри класса — одной. Пустые строки — инструмент смыслового деления кода.

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

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

Принципы оформления кода

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

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

Пустые строки. Функции верхнего уровня и определения классов отбивайте двумя пустыми строками, методы внутри класса — одной. В крайнем случае отбивайте смысловые блоки функций двумя строками. Пустые строки — инструмент смыслового деления кода.

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

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

Чтобы привести в порядок этот текст, возьмём за основу единую структуру для каждого правила:

Принцип — утверждение

Рекомендация — повелительное наклонение

Объяснение — в свободной форме, по желанию

Применим структуру к первому абзацу текста: принцип, рекомендация, объяснение.

Распространим на все абзацы.

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

Первый вариант — превратить все принципы в выражения с глаголом в неопределённой форме. Получается что‑то вроде советов, но не везде это выглядит элегантно.

Другой вариант — обозначить, о чём правило. Выглядит элегантнее.

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

Теперь все правила организованы единообразно:

Ключевое слово — существительное

Совет — повелительное наклонение

Исключение — повелительное наклонение

Объяснение — в свободной форме, по желанию

Заголовок

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

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

Редак­тор дол­жен стре­миться поста­вить заго­ло­вок к ста­тье, про­мо­стра­нице, тек­сту о себе, пуб­ли­ка­ции в Фейс­буке, даже к СМС или пуш‑уве­дом­ле­нию. Это не только сде­лает текст при­вле­ка­тель­нее, но и сра­бо­тает как про­верка: если редак­тор не может подо­брать заго­ло­вок, то у тек­ста про­блема со струк­ту­рой и логикой.

Всегда ставьте заголовки

Заголовок

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

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

Редактор должен стремиться поставить заголовок к статье, промостранице, тексту о себе, публикации в Фейсбуке, даже к СМС или пуш‑уведомлению. Это не только сделает текст привлекательнее, но и сработает как проверка: если редактор не может подобрать заголовок, то у текста проблема со структурой и логикой.

Всегда ставьте заголовки

Заго­ло­вок помо­гает при­влечь вни­ма­ние к тек­сту или его части. Корот­кий текст, набран­ный бóльшим кег­лем или жир­ным начер­та­нием и сто­я­щий на отдель­ной строке, выгля­дит как заго­ло­вок. Чита­тель обра­щает на него вни­ма­ние автоматически.

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

Однако замет­ным заго­ло­вок делает не раз­мер, не жир­ность, а кон­траст с обыч­ным тек­стом. Если набрать весь текст крупно, кон­траст про­па­дёт и текст пере­ста­нет быть привлекательным.

Про­ек­ти­руйте заго­ловки так, чтобы чита­тель на них отды­хал. Доста­точно поста­вить заго­ло­вок к ста­тье и раз­бав­лять её под­за­го­лов­ками после каж­дых 7⁠—10 абза­цев текста.

Если ста­вить заго­ловки слиш­ком часто, чита­тель уста­нет от смены формата.

Сначала вы прочитаете это

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

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

Дайте гла­зам отдохнуть

Хорошо спро­ек­ти­ро­ван­ный заго­ло­вок даёт чита­телю отдох­нуть: он корот­кий, кон­траст­ный и окру­жён основ­ным тек­стом. Слиш­ком длин­ные или частые заго­ловки будут мешать.

Не ставьте заголовки слишком часто

Хорошо спро­ек­ти­ро­ван­ный заго­ло­вок даёт чита­телю отдохнуть.

Избе­гайте конфликтов

Заго­ловки не должны кон­флик­то­вать друг с дру­гом и основ­ным текстом.

Корот­кий и контрастный

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

Это отвлекает

Слиш­ком длин­ные и частые заго­ловки будут мешать.

И от этого устаёшь

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

Окру­жайте заго­ло­вок текстом

Сле­дите, чтобы заго­ловки не сто­яли слиш­ком близко.

Сначала вы прочитаете это

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

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

Дайте глазам отдохнуть

Хорошо спроектированный заголовок даёт читателю отдохнуть: он короткий, контрастный и окружён основным текстом. Слишком длинные или частые заголовки будут мешать.

Не ставьте заголовки слишком часто

Хорошо спроектированный заголовок даёт читателю отдохнуть.

Избегайте конфликтов

Заголовки не должны конфликтовать друг с другом и основным текстом.

Короткий и контрастный

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

Это отвлекает

Слишком длинные и частые заголовки будут мешать.

И от этого устаёшь

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

Окружайте заголовок текстом

Следите, чтобы заголовки не стояли слишком близко.

Заголовок помогает привлечь внимание к тексту или его части. Короткий текст, набранный бóльшим кеглем или жирным начертанием и стоящий на отдельной строке, выглядит как заголовок. Читатель обращает на него внимание автоматически.

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

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

Проектируйте заголовки так, чтобы читатель на них отдыхал. Достаточно поставить заголовок к статье и разбавлять её подзаголовками после каждых 7⁠—10 абзацев текста.

Если ставить заголовки слишком часто, читатель устанет от смены формата.

Скрыто 78 разворотов

Илья­хов Мак­сим Олегович

Инфор­ма­ци­он­ный стиль

  • Арт‑дирек­тор и изда­тель Артём Горбунов

  • Иллю­стра­тор Андрей Кокорин

  • Дизай­нер обложки Вла­ди­мир Колпаков

  • Раз­ра­бот­чики Рустам Кул­ма­тов,
    и Васи­лий Половнёв

  • Тести­ров­щик Сер­гей Фролов

  • Книга набрана шриф­тами
    «Бюро­се­риф» и «Бюросанс»

  • Дизайн‑бюро Артёма Гор­бу­нова
    Большая Новодмитровская улица,
    дом 36, стро­е­ние 2
    Москва, Рос­сия, 127015

Ильяхов Максим Олегович

Информационный стиль

  • Арт‑директор и издатель Артём Горбунов

  • Иллюстратор Андрей Кокорин

  • Дизайнер обложки Владимир Колпаков

  • Разработчики Рустам Кулматов,
    и Василий Половнёв

  • Тестировщик Сергей Фролов

  • Книга набрана шрифтами
    «Бюросериф» и «Бюросанс»

  • Дизайн‑бюро Артёма Горбунова
    Большая Новодмитровская улица,
    дом 36, строение 2
    Москва, Россия, 127015