Scientific Writing Toolkit
details
highlights
Toggle:
verb report
frequent phrases
clutter
Reports:
getting started
Help:
scientific writing toolkit - a short (mis)introduction
https://github.com/pkorus/swtk

The sole purpose of this document is to serve as an example of bad writing - an excellent battlefield for the scientific writing toolkit. We 'll quickly go through some examples of possible pitfalls that endanger your manuscript's clarity, and use them to illustrate existing text analysis modules. For more information (and for the sake of your sanity), refer to more comprehensive, and better written, sources [1].

Strengthening the Verbs

This is one of the most common problems. Overusing weak verbs (like `` is '' or `` has '') is the cause of your problems. It is boring the reader, making them yawn, and also makes your message unmemorable. It is your duty to maintain his attention. It is also important to remember - your manuscript is supposed to be pleasant to read. It is good when your writing is to the point. There are ways to deal with it, though.

Keeping this in mind, make sure to use strong verbs. Engage the reader; grip his attention early - never let go:) Be succinct. Dispense with redundant clutter and confounding doublespeak. Convey your message clearly. Good writing helps your `` take home message '' be memorable. Adapt to your readership.

Verb Excavation

Buried verbs, you know, the ones that are far, really far, far away from the subject, make your text really insufferable. A recent large-scale analysis of 37 diverse languages, performed by scholars from MIT, and published not very long ago in the Proceedings of the National Academy of Sciences of the United States of America, provides evidence that the dependency length tends to be minimized across many languages [1]. The term, being more general than just a subject-verb property - and I am really glad you made it this far in this paragraph - refers to syntactically related words. At this point, you should have been doubtlessly convinced that sentences with long dependencies are more difficult to read. So make your readers a solid, and keep the scientific writing toolkit close, and your subjects and verbs closer.

Hunting Clutter

This section provides a review that is based on enumeration of unnecessary words and phrases and words. Very often, one could even say typically, your first draft will be scattered with unnecessary clutter. There are many words you could have used for this purpose. There are two primary suspects that are typically probably guilty of making your writing weak and without strength. The list includes, but is not limited to, two items listed below in an itemization environment which serves only the purpose of showing you that the scientific writing toolkit can indeed support itemization environments, even though only not nested ones are properly handled:

The first wrongdoing culprit is based on production of sentences where a supposedly smart-looking noun (like `` enumeration '' or `` review '') that most likely is a nice strong verb in an alternative realty where your writing does not suck. In that better (although probably not yet perfect) reality, this section has most likely started with a statement like: `` This section reviews and enumerates unnecessary words and phrases that often run rampant in your first draft. ''

There are also figures that can be clutter. The purpose of this figure is to perform introduction of no new information to this document. And maybe to show you that captions of the figures can be included in your report. While we 're at it, \(\sum_ { i=1 } ^ { \infty } \frac { 1 } { 2^n } =\frac { 1 } { 2 } + \frac { 1 } { 4 } + \ldots \).

Typically, the second unwanted garbage in your shiny new manuscript is probably an epidemic-like event that causes a presence of totally unnecessary vague adverbs that doubtlessly are vague and meaningless and are possibly and actually not needed where they are. While sometimes you can use adverbs occasionally, make sure to usually keep their population-based property to minimum. Totally !

Staying Active

While most journals are far enough from adopting corporal punishment for using passive voice, it should be kept in mind that words are typically spoken in active voice. Such sentences are simply more natural to parse. It is rather expected by people that the sentence is begun with a subject, and the subject is followed by a verb. My words are not to be misunderstood here. Passive voice is to be used. But it is to be used thoughtfully. And from time to time, your mind should be crossed by a simple question - would n't this sentence be clearer if it were written in a way that the words are usually put in?

Getting started
help

You are looking at a manuscript analysis report. The analyzed paper is visible on the left. This panel allows you to interact with the report. Available results are listed here - each with a general summary. Click the report name to highlight relevant fragments of the text. Use the details link to see more information, and highlight individual items of the report.

Shortlist of 10 most important writing tips:
  1. Use active voice.
  2. Prefer strong verbs; do not turn them into nouns.
  3. Put statements in positive form.
  4. Omit needless words (filter / stop-words).
  5. Do not bury the very.
  6. One topic per paragraph: start with the topic sentence; end with emphasis or important consequences.
  7. Ensure logical flow of ideas from paragraph to paragraph.
  8. Choose the right punctuation: commas, colons, parenthesis, etc.
  9. Use emphatic words at the end of a sentence.
  10. Maintain parallel structure when enumerating terms.

Read more:

Statistics
details
4,689 chars, 749 words
  • characters : 4,689
  • non-space characters : 3,813
  • words : 749
  • unique words : 358
  • non-space characters (abstract) : 352
  • words (abstract) : 67
  • sentences : 48
  • paragraphs : 9
  • begun pages (1,500 chars) : 4
Part of Speech Tagger
help
details
130 verbs, 166 nouns
Part of speech (POS) tagger based on maximal entropy.
  • Counts occurrences of specific tags
  • Highlights verbs, modals, and adjectives.
POS tagging is not 100% accurate - the statistics & tags should be considered as estimates.
  • nouns : 166
  • verbs : 130
  • preposition : 74
  • adjectives : 59
  • adverbs : 58
  • verbs, past participle : 27
  • personal pronoun : 21
  • modals : 10
  • gerunds : 10
  • adjectives, comparative : 8
  • verbs, past tense : 4
  • adjectives, superlative : 3
Bigrams
help
No frequent bigrams
Frequently occurring (at least 5 times) pairs of words.
Trigrams
help
details
1 popular trigrams: scientific writing toolkit, ...
Frequently occurring (at least 3 times) triples of words.
  • scientific writing toolkit : 3
Sentence length
details
2 long sentences (4.2%)
  • extra short sentences : 5
  • extra long sentences : 2
Buried verbs
help
details
1 difficult sentences (2.1%)
Finds sentences with potentially buried verbs (far away from the subject).
  • Sentences with buried verbs: 1
Filter words & phrases
help
details
19 words and 3 phrases
Finds vague and colloquial words and phrases typical for spoken language; if possible, offers an explanation or a substitute. Hover over an element to see the suggestion.
  • and also - often redundant
  • there are - boring, consider rephrasing
  • not - consider rephrasing to a positive construction
  • 19 filter words
Passive voice sentences
help
11 sentences (22.9%)
Finds sentences in passive voice.
Rare words
help
No rare words found
Highlights rare words based on a provided dictionary (by default 5,000 words from Brown corpus).
Acronyms
help
No acronyms found
Finds frequently used capital-letter acronyms (e.g., IEEE) and checks if they are explained in the text.
Weak verbs
help
45 of 130 verbs (34.6%)
Finds weak, overused verbs like: to be, to do, to have
report generated with scientific writing toolkit © 2015 PaweÅ‚ Korus