Skip to content

MooersLab/writing-log-md

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 

Repository files navigation

Version License: MIT

writing-log-md: Writing log template in markdown

Introduction

Use this writing log in parallel to the main writing project document to track your progress and record your plans. This template can be used in any text editor that supports Markdown. Markdown is a simple markup language. The files are usually rendered to either PDF or HTML. The resulting files are very attractive. This README.md file is written in the GitHub flavor of markdown.

Compatiable text editors include Visual Studio Code, Vim, NeoVim, Emacs, TextMate, Sublime Text, and so on. For an informal review and install instructions for 18 leading text editors, visit here.

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.

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

  • project intiation
  • daily entries
  • future additions and tangents
  • Guidelines, checklists, protocols, and helpful tips

The subsections of these four sections are shown below.

Project intiation

  • 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

Sources of funding

  • NIH: R01 CA242845
  • NIH: R01 AI088011
  • NIH: P30 CA225520 (PI: R. Mannel)
  • NIH: P20 GM103640 and P30 GM145423 (PI: A. West)

Update history

Version Changes Date
Version 0.3.1 Added badges, funding, and update table. 2024 August 12