Skip to content

Instantly share code, notes, and snippets.

@mimoo

mimoo/advice.md

Last active June 25, 2021 15:10
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save mimoo/397399196011aedc9c9f7fb0218c7dbb to your computer and use it in GitHub Desktop.
Save mimoo/397399196011aedc9c9f7fb0218c7dbb to your computer and use it in GitHub Desktop.
Download ZIP
Writing a book with asciidoc
Raw
advice.md

I wrote a book using asciidoc, so here are some advice.

  • Setup scripts to automate your tasks as much as possible.
  • Make sure you understand and follow your publisher's requirements as soon as possible.
  • Before copy editing, add line breaks between every sentences, it'll make the git diff much easier to parse once you get there. Also use https://github.com/banga/git-split-diffs
  • Use flamegraphs to make sure that sections are not too long, not too short https://gist.github.com/mimoo/bae1065d92efe9e18b75bb4a86834f6a
  • Always write section titles like someone is reading them to see if they sound interesting: https://gist.github.com/mimoo/60f35cf79593171d114247403671307e
  • Always, always, outline your chapter before starting to write it. Every section should teach a specific and meaningful aspect of your chapter
  • Have real deadlines to avoid spending too much of your time on a specific chapter
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment