Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/MooersLab/writing-log-md

Writing log template in markdown
https://github.com/MooersLab/writing-log-md

accountability daily-log hypothesis-centered-writing hypothesis-driven-research master-document personal-productivity planning-document planning-tool project-management scientific-writing second-brain self-monitoring self-regulation stress-management time-management voice-commands writing-accountability writing-productivity writing-project-management

Last synced: about 1 month ago
JSON representation

Writing log template in markdown

Awesome Lists containing this project

README 

        
![Version](https://img.shields.io/static/v1?label=writing-log-md&message=0.3.1&color=brightcolor)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/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](https://www.markdownguide.org/) 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](https://mooerslab.github.io/pymolsnips/#editors).



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



- [Writing Log template in LaTeX](https://github.com/MooersLab/writingLogTemplate). The favored format. LaTeX beginers can use this document easily on Overleaf without any configuration.

- [Writing log template in Org-mode](https://github.com/MooersLab/writingLogTemplateInOrg) Has all of the features of the LaTeX variant. Favored by many Emacs users. Org-mode is a powerful analog of markdown that can interpret LaTeX code blocks. It is vastly more capable than markdown. It even supports literate programming.

- [Writing log template in reStructuredText](https://github.com/MooersLab/writing-log-rst) reStructuredText is used by programmers for documentation.

- [Writing log template in ODT](https://github.com/MooersLab/writing-log-odt) ODT can be read by Open Office, LibreOffice and MS Word.

- [Writing log template in DOCX for MS Word](https://github.com/MooersLab/writing-log-docx) MS Word variant. Probably the least suitable format for this task.

- [Voice computing related repos](https://github.com/MooersLab#voice-computing)

- [LaTeX manuscript template](https://github.com/MooersLab/manuscriptInLaTeX/edit/main/README.md)

- [Org-mode manuscript template](https://github.com/MooersLab/manuscriptInOrg/edit/main/README.md)

- [Slideshow template in LaTeX](https://github.com/MooersLab/slideshowTemplateLaTeX)

- [Annotated bibliography Template in LaTeX](https://github.com/MooersLab/annotatedBibliography)

- [Track writing progress in 2024 and 2025](https://github.com/MooersLab/writing-progress-2024-25)

- [Diary for 2024 in LaTeX](https://github.com/MooersLab/diary2024inLaTeX)

- [latex-emacs profile](https://github.com/MooersLab/latex-emacs)

- [latex-emacs profile](https://github.com/MooersLab/latex-emacs)

- [default Emacs profile](https://github.com/MooersLab/configorg)

- [snippets for latex-mode in Emacs](https://github.com/MooersLab/snippet-latex-mode)

- [Quizzes about Emacs to improve recall of keybindings](https://github.com/MooersLab/qemacs)

- [Slides from talk about GhostText, Data Science Workshop, July 2022](https://github.com/MooersLab/DSW22ghosttext)

- [Video link to talk about GhostText, Data Science Workshop, July 2022](https://mediasite.ouhsc.edu/Mediasite/Channel/python/watch/4da0872f028c4255ae12935655e911321d)

- [Slideshow about using LaTeX in Emacs, Berlin Emacs Meetup, 31 August 2022](https://github.com/MooersLab/BerlinEmacsAugust2022)

- [The writer's crede](https://github.com/MooersLab/thewriterslaw)



## 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      |