-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathwritingLogTemplateVer7.tex
990 lines (684 loc) · 26.5 KB
/
writingLogTemplateVer7.tex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
% Created 2024-08-27 Tue 11:05
% Intended LaTeX compiler: pdflatex
\documentclass[11pt,letterpaper]{article}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{graphicx}
\usepackage{longtable}
\usepackage{wrapfig}
\usepackage{rotating}
\usepackage[normalem]{ulem}
\usepackage{amsmath}
\usepackage{amssymb}
\usepackage{capt-of}
\usepackage{hyperref}
\usepackage{amsmath}
\usepackage{amsfonts}
\setlength{\parindent}{0pt} % make block paragraphs
\usepackage{makeidx}
\usepackage{graphicx}
\usepackage{xurl} % permit line breaks in urls
\usepackage{hyperref}
\usepackage[letterpaper, total={7in, 9in}]{geometry}
\usepackage{datetime2}
\usepackage{minted}
\usepackage{ulem}
\setlength{\parindent}{0pt} % make block paragraphs
\usepackage{spreadtab}
%Print page numbers in the upper right corner rather than the bottom center.
\pagestyle{myheadings}
\usepackage{parskip} % add a blank line between paragraphs upon export to PDF.
% Code for plotting table
\usepackage{pgfplots}
\usepackage{pgfplotstable}
\usepackage{booktabs}
\usepackage{array}
\usepackage{colortbl}
\pgfplotstableset{% global config, for example in the preamble
every head row/.style={before row=\toprule,after row=\midrule},
every last row/.style={after row=\bottomrule},
fixed,precision=2,
}
% todolist env from https://tex.stackexchange.com/questions/247681/how-to-create-checkbox-todo-list
% done with checkmark, wontfix with x, next with finger.
\usepackage{pifont}
\newcommand{\nmark}{\ding{42}}% next
\newcommand{\cmark}{\ding{51}}% checkmark
\newcommand{\xmark}{\ding{55}}% x-mark
\newcommand{\wmark}{\ding{116}}% wait mark, inverted triangle representing yield sign
\newcommand{\done}{\rlap{$\square$}{\raisebox{2pt}{\large\hspace{1pt}\cmark}}%
\hspace{-2.5pt}}
\newcommand{\wontfix}{\rlap{$\square$}{\large\hspace{1pt}\xmark}}
\newcommand{\waiting}{\rlap{\raisebox{0.18ex}{\hspace{0.17ex}\scriptsize \wmark}}$\square$}
% \newcommand{\next}{\nmark}%
\bibliographystyle{cell}
\makeindex
\author{Blaine Mooers}
\date{\today}
\title{Writing log for this hot paper}
\hypersetup{
pdfauthor={Blaine Mooers},
pdftitle={Writing log for this hot paper},
pdfkeywords={},
pdfsubject={},
pdfcreator={Emacs 29.3 (Org mode 9.6.15)},
pdflang={English}}
\begin{document}
\maketitle
\maketitle
\tableofcontents
\section{Project initiation}
\label{sec:org705758a}
\index{project initiation}
\subsection{Rationale for this article}
\label{sec:org61e5f8d}
\index{rationale}
\subsection{Audience for the paper}
\label{sec:org76ee2fb}
\index{audience for the paper}
\subsection{Potential target journals for submission}
\label{sec:org498c3a1}
\index{target journals}
\subsection{Related projects}
\label{sec:org4925286}
\index{related projects}
\subsection{Draft Introduction}
\label{sec:org441690d}
\index{draft!introduction}
\subsection{Potential results}
\label{sec:org4d9ce3c}
\index{draft!results}
\subsection{Potential discussion points}
\label{sec:org4ac6bc1}
\index{draft!discussion}
\subsection{Prior discussion points}
\label{sec:org750c544}
\index{draft!prior discussion points}
\subsection{Potential titles}
\label{sec:orgecfef6e}
\index{darft!potenital titles}
\subsection{Potential Keywords}
\label{sec:orge9d69b1}
\index{darft!potenital keywords}
\subsection{Potential Abstract}
\label{sec:org313b688}
\index{draft!potential abstract}
\subsection{Abbreviations}
\label{sec:org4790ab3}
\index{draft!abbreviations}
\subsection{Potential collaborators: name; institution;e-mail}
\label{sec:org153342f}
\index{draft!collaborators}
\begin{itemize}
\item
\item
\item
\item
\end{itemize}
\subsection{Potential competitors: name; institution;e-mail}
\label{sec:org4616e75}
\index{draft!competitors}
\begin{itemize}
\item
\item
\end{itemize}
\subsection{Potential reviewers: name; institution; e-mail}
\label{sec:org1a3c6b6}
\index{draft!potential reviewers}
\begin{enumerate}
\item
\item
\item
\item
\item
\end{enumerate}
\subsection{Draft cover letter}
\label{sec:org9c2e134}
\index{draft!cover letter}
\subsection{Acknowledgements}
\label{sec:org408db1e}
\index{draft!acknowledgements}
\subsection{Funding sources}
\label{sec:org557a1fc}
\index{data!funding sources}
\section{Data}
\label{sec:orgac118c3}
\index{data}
\subsection{Inventory of data on hand}
\label{sec:org8c8d121}
\index{data inventory!data on hand}
\begin{table}[htbp]
\caption[Stored data]{Projects's stored data.}
\centering
\begin{tabular}{ll}
Description & Location\\[0pt]
\hline
SSRL images February 2024 & MooersHD11\\[0pt]
SSRL images August 2024 & MooersHD12\\[0pt]
\end{tabular}
\end{table}
\subsection{Inventory of project's required external software}
\label{sec:org53bfb01}
\index{data inventory!external software}
\begin{table}[htbp]
\caption[External software]{Projects's required external software.}
\centering
\begin{tabular}{ll}
Description & Location\\[0pt]
\hline
CCP4 & iMac2\\[0pt]
Phenix & iMac3\\[0pt]
\end{tabular}
\end{table}
\subsection{Inventory of project's software repositories}
\label{sec:org2cc439e}
\index{data inventory!sofware repos}
\begin{table}[htbp]
\caption[Software repos]{Projects's software repositories.}
\centering
\begin{tabular}{ll}
Description & Location\\[0pt]
\hline
Repo1 & GitHub\\[0pt]
Repo2 & Codeberg\\[0pt]
\end{tabular}
\end{table}
\subsection{Relevant videos}
\label{sec:orgd079f47}
\index{data inventory!videos}
\begin{table}[htbp]
\caption[Related videos]{Videos related to project.}
\centering
\begin{tabular}{ll}
Description & URL\\[0pt]
\hline
& \\[0pt]
& \\[0pt]
\end{tabular}
\end{table}
\subsection{Relevant blogs}
\label{sec:org1ea7417}
\index{data inventory!relevent blogs}
\begin{itemize}
\item
\item
\item
\item
\item
\item
\end{itemize}
\subsection{Relevant literature sources}
\label{sec:orgfaf2ecf}
\index{data inventory!literature sources}
\begin{itemize}
\item
\item
\item
\item
\item
\item
\end{itemize}
\subsection{Relevant collections of PDFs in Research Rabbit and the like}
\label{sec:org92c5c67}
\index{data!collections of PDFs}
\begin{itemize}
\item
\item
\item
\item
\item
\item
\end{itemize}
\subsection{Project's progress summary for annual grant report}
\label{sec:org457e744}
\index{annual grant report}
\begin{itemize}
\item
\item
\item
\item
\item
\item
\item
\end{itemize}
\subsection{Project's progress summary for annual report to college}
\label{sec:orge9d8dfd}
\index{data!annual college report}
\begin{itemize}
\item
\item
\item
\item
\item
\item
\item
\end{itemize}
\section{Plans to support the writing project}
\label{sec:orgea63d3e}
\index{plans!support for the writing project}
\subsection{Timeline for experiments}
\label{sec:orgcadfce6}
\index{plans!timeline for experiments}
\subsection{User proposals: national labs}
\label{sec:org1c3c27b}
\index{plans!user proposals for national labs}
\subsection{User proposals: HPC}
\label{sec:org5f34f12}
\index{plans!user proposals for high performance computing}
\subsection{Literature retrieval}
\label{sec:org33ac870}
\index{plans!literature retrieval}
\subsection{Funding}
\label{sec:orgfacb6dc}
\index{plans!funding}
\subsection{Recruitment of collaborators}
\label{sec:orgf8fb113}
\index{plans!collaborators}
\subsection{Recruitment of workers}
\label{sec:org2c359c8}
\index{plans!recruitment of workers}
\subsection{Career development plans}
\label{sec:org6ce5116}
\index{plans!carreer development}
\subsection{Biosafety}
\label{sec:org45405fc}
\index{plans!biosafety}
\subsection{Authentication of key biological resources}
\label{sec:org1fc8a03}
\index{plans!authentication!biological resources}
\subsection{Authentication of chemical resources}
\label{sec:orgbaf9894}
\index{plans!authenticiation!chemical resources}
\subsection{Statistical sampling and power analysis}
\label{sec:org40c4c5e}
\index{plans!sampling plan}
\index{plans!power analysis}
\subsection{Computer simulations}
\label{sec:org8c81f3c}
\index{plans!simulation}
\subsection{Data analysis plans}
\label{sec:org565de05}
\index{plans!analysis}
\subsection{Data management plans}
\label{sec:orgb344dfa}
\index{plans!data management}
\subsection{Data sharing plans}
\label{sec:orgb3e33b3}
\index{plans!data sharing}
\subsection{The NIH PEDP}
\label{sec:org20c2c36}
\index{plans!NIH PEDP}
\section{Project management for timely completion}
\label{sec:orgc945418}
\index{plans!timely completion}
\subsection{Checklist for manuscript completion}
\label{sec:org6f0ef94}
\index{manuscript completion!checklist}
\begin{itemize}
\item[{$\square$}] Central hypothesis identified.
\item[{$\square$}] Introduction drafted to define scope.
\item[{$\square$}] Results ordered by relevance to the central hypothesis.
\item[{$\square$}] Results imagined as figures and tables.
\item[{$\square$}] Results outlined to the subsection level.
\item[{$\square$}] Results outlined to the paragraph level.
\item[{$\square$}] Figures have been conceptualized.
\item[{$\square$}] Figures have been drafted.
\item[{$\square$}] Figure legends have been drafted.
\item[{$\square$}] Tables have been conceptualized.
\item[{$\square$}] Tables have been drafted.
\item[{$\square$}] Table legends have been drafted.
\item[{$\square$}] Paragraphs in the Results section drafted.
\item[{$\square$}] Results concluding sentences checked.
\item[{$\square$}] Discussion points identified.
\item[{$\square$}] Prior publications checked for Discussion points.
\item[{$\square$}] Discussion paragraphs drafted.
\item[{$\square$}] Discussion concluding sentences checked.
\item[{$\square$}] Discussion subsections check with the central hypothesis.
\item[{$\square$}] Citations have been entered.
\item[{$\square$}] Citations have been checked.
\item[{$\square$}] Bibliographic information has been checked.
\item[{$\square$}] Accuracy of Bibliographic information checked.
\item[{$\square$}] Citations have entries in the annotated bibliography.
\item[{$\square$}] Abstract drafted.
\item[{$\square$}] Supplemental materials assembled.
\item[{$\square$}] The first draft is finished.
\item[{$\square$}] Round 1 of rewriting finished.
\item[{$\square$}] Round 2 of rewriting finished.
\item[{$\square$}] Ready for reverse outline.
\item[{$\square$}] Round 3 of rewriting.
\item[{$\square$}] Solicit review by co-authors.
\item[{$\square$}] Internal polishing editing.
\item[{$\square$}] Ready for intense review by a professional writer.
\item[{$\square$}] Intensive review revisions have been incorporated.
\item[{$\square$}] Penultimate draft ready for internal proofreader.
\item[{$\square$}] Penultimate review revisions incorporated.
\item[{$\square$}] Manuscript ready for submission.
\end{itemize}
\subsection{Timeline with milestones}
\label{sec:org5df709e}
\index{manuscript completion!milestones}
\subsection{Assessments of current state}
\label{sec:org013c949}
\index{manuscript completion!current state}
\subsubsection{Date:}
\label{sec:org2f83dfa}
\index{manuscript completion!by date}
\begin{enumerate}
\item How far is the manuscript from being completed (in percent completion)?
\label{sec:orgf92b3c3}
\index{manuscript completion!percent completion}
\item List what keeps the manuscript from being submitted today.
\label{sec:org9a06e76}
\index{manuscript completion!holding back}
\item List what is missing from the manuscript that could improve its impact.
\label{sec:orgfe40660}
\index{manuscript completion!what is missing}
\item What could be removed from the manuscript to streamline it?
\label{sec:org8d843c8}
\index{manuscript completion!streamlining}
\end{enumerate}
\section{Daily Log}
\label{sec:orgd71bb8f}
\index{daily log}
\subsection{2024 August 10}
\label{sec:org9956e50}
\index{2024 August 10}
Accomplishments:
\begin{itemize}
\item
\item
\item
\end{itemize}
\subsection{Next action}
\label{sec:org4278119}
\index{next action}
\subsection{To be done}
\label{sec:org662851d}
\index{To be done}
\subsection{Word Count}
\label{sec:org59f9274}
\index{word count}
\begin{figure}[H]
\centering
\begin{tikzpicture}
\begin{axis}[
xlabel={Date},
ylabel={Word Count Cumulative},
% legend pos=south east,
% legend entries={},
]
\addplot table [x=Day,y=Words] {wordcount.txt};
\end{axis}
\end{tikzpicture}
\caption{Cummulative word count.}
\end{figure}
\begin{table}[]
\centering
\pgfplotstabletypeset[
columns/Date/.style={column name=Date},
columns/Day/.style={column name=Day},
columns/Word/.style={column name=Words},
]{wordcount.txt}
\caption{Date, day and wordcount.}
\label{tab:my_label}
\end{table}
\subsection{Update Writing Progress Notebook}
\label{sec:orge119d5a}
\index{writing progress notebook}
\subsection{Update Zettelkästen in org-roam}
\label{sec:org858e016}
\index{zettelkasten}
\section{Future additions and tangents}
\label{sec:org9665946}
\index{future additions and tangents}
\subsection{Ideas to consider adding to the manuscript}
\label{sec:orga36365b}
\index{future additions and tangents}
\begin{itemize}
\item
\item
\item
\end{itemize}
\subsubsection{Introduction}
\label{sec:org7ce5f97}
\index{introduction}
\begin{itemize}
\item
\item
\item
\item
\end{itemize}
\subsubsection{Results}
\label{sec:org14ff79d}
\index{results}
\begin{itemize}
\item
\item
\item
\item
\end{itemize}
\subsubsection{Discussion}
\label{sec:org65d8ba6}
\index{discussion}
\begin{itemize}
\item
\item
\item
\end{itemize}
\subsection{To be done someday}
\label{sec:orgbde3dff}
\index{to be done someday}
\subsection{Spin off writing projects}
\label{sec:org54f9f71}
\index{spin off writing progect}
\begin{itemize}
\item ::
\item ::
\item ::
\item ::
\end{itemize}
\section{Guidelines, checklists, protocols, helpful hints}
\label{sec:org99565c2}
\index{guidelines}
\index{checkists}
\index{protocols}
\index{helpful hints}
\subsection{Daily protocol}
\label{sec:orgf8f4f32}
\index{daily protocol}
\begin{enumerate}
\item At start of work session, review the timeline, recent daily entries, next action item , and
to-do list.
\item Write the goal(s) for the current writing session as a means of
engaging mentally in the work. This prose could be retained or
deleted at the end of the work session.
\item At the end of the work session, move finished items to an achievement
list for the day.
\item Move the unfinished items to the to-do list.
\item Identify the next task or action.
\item Update the wordcount.txt file, if you wrote anything.
\item Update the project Sheet in the Writing Progress Workbook.
\item Update your personal knowledge base.
\end{enumerate}
\subsection{Tips for using Overleaf}
\label{sec:orgacd22e6}
\index{tips for using Overleaf}
\begin{enumerate}
\item Chrome has the TextArea extension that is needed to run Grammarly in
Overleaf.
\item Use the shortcuts (new commands defined in the preamble) to save time
typing.
\item Where shortcuts are not possible, use templates.
\item View Overleaf project with Chrome to be able to run Grammarly via the
Chrome Grammarly extension.
\item code Snippets can be mapped to voice commands in Voice In Plus.
\end{enumerate}
\subsection{Protocol for running Grammarly in Overleaf}
\label{sec:org10f05e7}
\index{running Grammarly in Overleaf}
You must install Grammarly and Textarea extensions for Chrome. With your
project open in Overleaf, open the textarea icon in the upper right of
your browser and check the checkbox. This will convert the PDF viewport
into RichText. Hit the Grammarly icon. Grammarly will check the text in
the RichText viewport. Corrections that you make in the RichText
viewport are applied to your tex file in the left viewport. Note that
the preamble of the document will cause the text to be spread out. You
may have to scroll down a ways to see the document environment.
\subsection{Guidelines for debugging the annotated bibliography}
\label{sec:org9c06645}
\index{annotated bibliography!guideline for debugging}
For a template annotated bibliography, see
\url{https://github.com/MooersLab/annotatedBibliography}.
\begin{enumerate}
\item Escape with a forward slash the following: \&, \_, \%, and \#.
\item Title case the journal titles.
\item Replace unicode characters with \LaTeX{} code: e.g., replace Å with Å.
Not all \LaTeX{} document classes are compatible with unicode.
\item The primes have to be replaced with '.
\item The vertical red rectangles with a white dot in the middle should be
replaced with a whitespace.
\item There are two styles in the bibtex world: bibtex and biblatex. We are
using bibtex. It is simpler. It has fewer fields.
\item Use Google Scholar bibtex over Medline or PubMed biblatex.
\item Often the error is in the bibitem entry above the one indicated in
the error messages.
\item All interior braces must by followed by a comma, including the last
one.
\item When stumped, replace the entry with a fresh one from Google
Scholar.
\end{enumerate}
\subsection{Graphical Abstract}
\label{sec:org7749b1a}
\index{graphical abstract}
The following is copied from the Crystal Journal's
\href{https://www.mdpi.com/journal/crystals/instructions\#preparation}{author
guidelines}.
\begin{quote}
A graphical abstract (GA) is an image that appears alongside the text
abstract in the Table of Contents. In addition to summarizing the
content, it should represent the topic of the article in an interesting
way. The GA should be a high-quality illustration or diagram in any of
the following formats: PNG, JPEG, EPS, SVG, PSD or AI. Written text in a
GA should be clear and easy to read, using one of the following fonts:
Times, Arial, Courier, Helvetica, Ubuntu or Calibri. The minimum size
required for the GA is 560 \(\times\) 1100 pixels (height \(\times\)
width). When submitting larger images, please, keep to the same ratio.
\end{quote}
I usually make the mistake of treating the graphical abstract as an
afterthought. Then there is no time to make one during submission of the
manuscript. This can lead to delays or to the journal converting one of
your sub-figures into a graphical abstract. A good example of a
graphical abstract is found
\href{https://www.mdpi.com/2073-4352/11/3/273}{here}.
\subsection{Guidelines for benchmarks}
\label{sec:orgb1897f7}
\index{guidelines for benchmarks}
\subsection{Guidelines for using Writing Progress Notebook}
\label{sec:orgcb9d675}
\index{writing progress notebook!guidelines}
The writing progress notebook enables the tracking of progress on a
project basis \footnote{\url{https://github.com/MooersLab/writing-progress-2024-25}}. The Notebook automatically updates sums of words
written and minutes spent across all projects on a given day. It only
takes a few seconds to enter the number of words written and the time
spent for a specific project on that project's Google Sheet. If you have
Voice In plus activated, say the words "open sheet 37" to have the
worksheet for project 37 opened in the web browser. If not, click on
this direct link to the Google Sheet in the compiled PDF of this writing
log \footnote{\href{<insert link for specific sheet>}{<insert link for specific sheet>}}.
\subsection{Guidelines for using a personal knowledge base}
\label{sec:orgf9f76d8}
\index{personal knowledge base!guidelines}
If you maintain a knowledge base like a Zettelkästen in org-roam or
Obsidian or Notion, you might consider adding literature notes and
permanent notes at the end of a work session \footnote{\url{https://wiki2.org/en/Zettelkasten}} \textsuperscript{,}\,\footnote{\url{https://wiki2.org/en/Comparison\_of\_note-taking\_software}}. The name of
the index for this project is \texttt{XXXXXXXXX}. Enter \texttt{Control-c n f} to find
this project note. This knowledge base can store information that you
may want to use eventually in the paper.
These notes that you may add might be in the form of what are called
\textbf{permanent notes} that include new insights or plans for the work. These
thoughts are not directly linked or derived from any particular
reference in the literature. Another kind of note is known as a
\textbf{citation note} or \textbf{literature note} is derived from a specific
reference. This kind of note will contain the BibTeX cite key.
Although such notes can be stored in an annotated bibliography
(\url{https://github.com/MooersLab/annotatedBibliography}), I seem less likely
to utilize this information while working on a manuscript because the
annotated bibliographies are in a different document. Because it is out
of sight, the annotated bibliography is also out of mind.
The advantage of keeping these bits of knowledge inside the writing log
is that you can link the entries made in the daily log section to these
bits of knowledge by using the label and ref macros of \LaTeX{}. You can
also set up label and ref pairs between to-do items and the bits of
knowledge. Some of these notes may refer to a particular reference, so
you can include the cite key with these notes if the reference has been
included in the BibTeX library file sourced at the bottom of this file.
I usually source the BibTeX library file that I am using in the
annotated bibliography for a particular project. Keeping these items
together in one document will improve the odds that you act upon the
collected information, reducing the mental bandwidth you have to commit
to managing this writing log.
Another approach I use sometimes is to include such information on lines
that have been commented out in the manuscript's tex document near where
I want to utilize that information. I must admit that this approach can
become a little unwieldy if the comments span many lines.
If you use the Pomodoro method, you would probably want to commit the
last one or two poms of a work session on a writing project to update
your knowledge base. If you have been lagging on doing such updates, you
may want to commit four to six poms to this kind of work; you might have
to do this over multiple days if you have fallen behind.
\subsection{Writer's Creed}
\label{sec:org7d1f302}
\index{writer's creed}
A writer does the following:
\begin{itemize}
\item Schedules daily writing time on workdays; takes a relaxed approach on weekends.
\item Shows up and writes during the scheduled writing time.
\item Stands up and walks around every 25 minutes for no more than 5 minutes (i.e., uses the Pomodoro technique).
\item Limits generative writing to 3-5 hours daily; spends the rest of the day on supportive tasks and other duties.
\item Overcomes writer's block by rewriting the last paragraph or reverse outlining a section.
\item Keeps near a list of tricks for overcoming writer's block.
\item Manages their energy by doing generative writing first, rewriting second, and supportive tasks later in the day.
\item Jumps into generative writing; does not wait to be inspired.
\item Does generative writing when half-awake early in the day and editing and rewriting when fully alert, generally mid to late morning.
\item Masters their writing tools without letting the tools master them.
\item Writes without distractions (no YouTube videos, TV, radio, etc.; playing classical music is okay sometimes).
\item Tracks the time spent and words written by project ID.
\item Takes credit for time spent reading material related to the project, especially if finished by making an entry in an annotated bibliography.
\item Uses a separate writing log for each writing project.
\item Makes writing social when it is mutually beneficial.
\item Reads and writes about writing at least once a fortnight.
\item Keeps up on weasel words, wordy phrases, cliché, and other junk English; reviews this list quarterly to avoid their use.
\item If a scientist, writes with precision, clarity, and conciseness. The order is in descending importance. Has memorized this list.
\item Uses computerized writing tools responsibly, not blindly: Takes full responsibility for the final draft.
\item Documents in writing log any use of AI to generate or paraphrase passages.
\item Uses dictation software for some generative writing.
\item Uses software tools like \textbf{Grammarly}, the \textbf{LanguageTool}, and the \textbf{Hemingway.app} to stimulate improvements in their writing.
\item Knows enough about good writing to accept only useful suggestions.
\item Does not blindly accept noun clusters, English contractions, and weasel words suggested by AI software.
\item Uses copilot when exhausted to complete sentences.
\item Uses the paraphrasing tool of some chatbots (e.g. TexGPT) cautiously and only to generate intermediate drafts.
\item Reviews this list periodically.
\end{itemize}
Premises of the creed:
\begin{itemize}
\item Writing is any activity that advances a writing project. Most of the time spent on these writing activities does not involve generative writing.
\item Generative writing is the most valuable activity: All other activities descend from it.
\item Generative writing and editing use different parts of the brain, so they should be done at separate times.
\item Generative writing is best done when half awake because your internal editor is not fully on so new ideas are more likely to emerge.
\item Generative writing be done by dictation while commuting if planned before the commute.
\item Editing is best done when fully awake because your internal editor will be activated. (Be careful; late-night editing can keep you awake later than intended and interfere with your sleep pattern.)
\item Most of the time spent on actual \textbf{writing} involves rewriting.
\item Planning is an important (underemphasized) component of writing.
\item Writing includes any activity that advances a writing project.
\item The word count does not capture most writing-related activities. Hence, the time spent on these activities must be tracked to document these efforts.
\item Time tracking is an essential component of time management. It is hard to manage what you do not measure. \textbf{\textbf{Writing involves a lot of time management!!}}
\item 90 minutes of generative writing per day on one project is the optimal length of time due to our [ultradian cycles](\url{https://www.youtube.com/watch?v=ezT8kGzYOng}). Thank you to my brother, Randall, for alerting me to this. Longer stretches of writing on one project are known as \textbf{binge writing}, which always leads to diminishing returns.
\item Writing includes reading the papers that you cite and those that you do not wind up citing. This reading activity can rejuvenate your momentum and inspire new ideas. It is best done in the evening so your subconscious can work overnight with the new insights. \textbf{\textbf{Writing involves feeding your subconscious: Feed our head!}}. Reading is grossly underemphasized in writing books. Time should be scheduled for it else it is less likely to be done.
\item Writing includes mundane tasks like managing bibliographic libraries and making figures; these are good afternoon activities.
\item Writing includes data analysis.
\end{itemize}
\section{Backmatter}
\label{sec:orgaf0f25b}
\bibliography{/Users/blaine/Documents/global.bib}
\printindex
\end{document}