Skip to content

Commit

Permalink
Avoid splitting short documents
Browse files Browse the repository at this point in the history
  • Loading branch information
dspinellis authored Jan 28, 2018
1 parent 578aecf commit 2a87513
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,21 @@ this was not a major issue in this study.
```
% Advantages of model-based development {{{3
```
* Avoid splitting short documents (such as a journal or conference paper)
into multiple files (e.g. `introduction.tex`, `methods.tex`, `results.tex`,
`conclusions.tex`).
Such splitting makes it difficult to work perform a number of tasks with
your editor:
* overview the material's composition
(e.g. the balance of the sections' length),
* globally search or search and replace a particular term, and
* move matter from one section to another.

When the document is split, these tasks require you to switch from one
file to another or to use external tools.
Feel free to split longer documents (such as a book or a thesis) in order
to shorten a project's long build and loading time.

* Finally, don't spend too much time on formatting.
Concentrate on communicating your ideas and on making your document
maintainable.
Expand Down

0 comments on commit 2a87513

Please sign in to comment.