Skip to content

MooersLab/writing-log-rst

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 

Repository files navigation

Version License: MIT

writing-log-rst: Writing log for reStructuredText

Introduction

ReStructuredText is favored by some computer programmers for generating documentation. It is a markup language that is intermediate between markdown and LaTeX in terms of the options available and the control over the output. The proceeding papers for the SciPy Conference are prepared in reStructuredText.

The writing log is a document that is external to the manuscript. It is used to store the plans and progress made on a one manuscript. It is tool for enhancing your focus and sustaining forward momentum on the writing project. It is also tool that ease re-engagement in an interrupted writing project. It is like a master thinking document or second brain for a writing project.

Instructions for using the writing log are found in the annotations in the template. You can delete these after they are no longer needed.

Version 0.3 of the writing log is divided into four sections:

  • Project initiation
  • Daily entries
  • Future additions and tangents
  • Guidelines, checklists, protocols, and helpful tips

The subsections of these four sections are shown below.

Project initiation

  • Rationale
  • Audience
  • Target journals
  • Related projects
  • Potential Introduction
  • Potential Results
  • Potential Discussion points
  • Prior discussion points
  • Potential titles
  • Potential keywords
  • Potential abstract
  • Abbreviations
  • Potential collaborators
  • Potential competitors
  • Potential reviewers
  • Draft cover letter

Daily entries

  • Daily protocol
  • Daily Log
  • Update writing progress notebook
  • Update personal knowledge base
  • Timeline or Benchmarks
  • Next action
  • To be done
  • Word Count

Future additions and tangents

  • Ideas to consider adding to the manuscript
    • Introduction
    • Results
    • Discussion
  • To be done someday
  • Spin off writing projects

Guidelines, checklists, protocols, helpful hints

  • Tips for using Overleaf
  • Protocol for running Grammarly in Overleaf
  • Guidelines for debugging the annotated bibliography
  • Graphical Abstract
  • Guidelines for benchmarks
  • Guidelines for using Writing Progress Notebook
  • Guidelines for using a personal knowledge base

Related projects of possible interest

About

writing-log-rst: Writing log for RestructuredText

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published