{"id":17059203,"url":"https://github.com/novoid/student-supervision-process","last_synced_at":"2025-06-30T06:33:10.727Z","repository":{"id":2759300,"uuid":"3757260","full_name":"novoid/Student-Supervision-Process","owner":"novoid","description":"How to organize supervision of the development of (LaTeX-) documents of students","archived":false,"fork":false,"pushed_at":"2017-08-09T21:56:07.000Z","size":7,"stargazers_count":12,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-28T14:16:37.981Z","etag":null,"topics":["education","pim","students","supervisor","tugraz","workflows"],"latest_commit_sha":null,"homepage":"http://tagstore.org","language":null,"has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/novoid.png","metadata":{"files":{"readme":"README.org","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-03-18T19:06:20.000Z","updated_at":"2022-10-24T16:25:39.000Z","dependencies_parsed_at":"2022-07-21T11:33:15.291Z","dependency_job_id":null,"html_url":"https://github.com/novoid/Student-Supervision-Process","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/novoid%2FStudent-Supervision-Process","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/novoid%2FStudent-Supervision-Process/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/novoid%2FStudent-Supervision-Process/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/novoid%2FStudent-Supervision-Process/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/novoid","download_url":"https://codeload.github.com/novoid/Student-Supervision-Process/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245068758,"owners_count":20555819,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["education","pim","students","supervisor","tugraz","workflows"],"created_at":"2024-10-14T10:33:14.609Z","updated_at":"2025-03-23T07:25:32.322Z","avatar_url":"https://github.com/novoid.png","language":null,"readme":"# Time-stamp: \u003c2017-08-09 23:54:50 vk\u003e\n# -*- coding: utf-8 -*-\n\n* What the heck is this for?\n\nThe author is supervising several student works. Since each of them is\nfinalizing their work more or less in parallel, there is a need for a\nstructured way of supervision.\n\nNo student should suffer from being forgotten nor should get feedback\ntoo late. Being a supervisor is not the biggest part of my job and so\nI need a *common* procedure. I simply can not remember/maintain the\npreferred data flow mechanism of each and every student. So students\nhave to adopt to my method.\n\nAnd this is document describes the method.\n\nPS: Do not hesitate and contact me if you have suggestions!\n\n* Process Components\n\nThe supervision process consists of multiple parts:\n- Following the Rules: how to keep students up to date on the process here\n- Communication Channels and Setup: how to exchange files and information\n- Individual Appointments: regular meetings with the students\n- Regular Submissions of PDF files: how to supervise content\n- Weekly LaTeX-Q\u0026A: there are always things you can learn about LaTeX\n- LaTeX Code: basic rules and direct feedback\n\n** Following the Rules\n\nThis process is hosted [[https://github.com/novoid/Student-Supervision-Process][as a github project]].\n\nYou can «follow» the project on github and regularly monitor its\nchanges which is recommended but not mandatory. General\n[[https://www.changedetection.com/][notifier-services]] are being blocked by github and can not be used for\nfollowing the [[https://github.com/novoid/Student-Supervision-Process/commits/master/][changes here]].\n\nChanges will be announced via email to all of my students.\n\n** Communication Channels and Setup\n\n*** Asynchronous Communication\n\nMy *preferred* way of communicating with you is via *email*. I am\nfairly good reachable per email, even on evenings and most weekends.\n\n*** Synchronous Communication\n\nIf you want to get in touch with me for instant feedback, call my\n*office phone number*. Either I am in my office and can answer your\ncall or (after four? times of ringing) you will be routed to my\ncellphone. If you land in my voice mail system, I am currently\nspeaking to someone else or my phone is off (during sleeping hours).\n\nYou might as well ask me for my *[[http://en.wikipedia.org/wiki/Jabber][Jabber]] ID*.\n\nSorry, I do have strong arguments against usage of Skype. But you\nmight as well ask me for my Google+ ID and schedule a *Google hangout*\nthere.\n\n*** Submitting PDF files\n\nI am using a tablet computer to read your PDF submission. This way I\nread and annotate the *content* of your thesis.\n\nPlease use [[https://syncthing.net/][Syncthing]] instead of cloud-based services like Dropbox. It\nmaintains our level of privacy without exposing data to the public\ncloud.\n\nSyncthing is available for all major operating systems except Apple\niOS because Apple is prohibiting tools like Syncthing as they\nprohibited tools like external keyboards for many years.\n\nCreate a Syncthing folder for your thesis using any name you wish. I\nrename it to «LASTNAME_THESISTYPE» on my side (only) anyway.\n(«Thesistype» is either «Bakk» or «DA».)\n\nAfter you have created your Synthing folder, please do send me your\ndevice ID ([[http://127.0.0.1:8384/][web interface]] \u003e Actions \u003e Show ID) and the ID of your\nshared folder (expand the folder in the web interface).\n\n*** Submitting LaTeX source code\n\nYou are going to set up a [[http://en.wikipedia.org/wiki/Git][Git]] repository especially for your LaTeX\ndocument. Even if you already have a Git repository for source code or\nsuch, please do create another one solely for your thesis document as\nwell.\n\nPlease contact me for getting information where to push your local Git\nchanges to.\n\nDo *not* wait for some final chapter or so to check in! *Check in\noften!* Use it as an off-site backup in case your computer fails or in\ncase you delete large portions of text by mistake. Never think that\nthis will not be the case. We are all humans so we all make mistakes.\nEven me :-)\n\n** Individual Appointments\n\nEach student gets a weekly 30 minute slot or a bi-weekly 60 minute\nslot. If you think I need to do a small internet research by myself\nfor a question you have got, email me your question(s) upfront.\n\nAgenda:\n- What happened since the last appointment?\n- What were the problems?\n- Probably: comments about the last PDF submission\n- Probably: comments about the LaTeX source\n- Next steps and deliverables until next appointment\n\nIf the appointment should be canceled, write me an email at least one\nday in advance. Short term cancels only via synchronous communication\nchannels such as phone.\n\n** Regular Submissions of PDF Files\n\nThis is about the *content* of your thesis.\n\nIf you finish a certain part of your document:\n1. Generate the PDF file\n2. Put it in the shared Syncthing folder\n3. Rename it to =YYYY-MM-DD_TYPE_LASTNAME_-_optional_things.PDF=\n4. Send me an email, describing the parts I should check\n\nFile name convention examples:\n- minimal example: =2012-03-18_DA_Smith.pdf=\n- example with comment: =2012-03-19_Bakk_Mueller_-_chap_2-4_ready_for_persual.pdf=\n\nAfter I checked the content of your document, you will may annotations\nin the PDF file which will be discussed at the next individual\nappointment.\n\nI might as well add comments in your LaTeX code as well.\n\n** Weekly LaTeX Questions and Answers\n\nWe will schedule a weekly hour for LaTeX-specific questions and best\npractices. It is *not mandatory* but highly recommended. Especially at\nan early stage of your thesis!\n\nI assume that you already have [[http://LaTeX.TUGraz.at][basic LaTeX knowledge]]. At this\nLaTeX-Q\u0026A I will show examples of LaTeX source code and suggest things\nthat spare you lots of time (and nerves).\n\nPlease be assured: although I stick to current LaTeX code issues of my\nstudents, this event is *not* intended to offend the work of single\npersons! It demonstrates optimizations and encourages learning for\neverybody.\n\nI will keep individual LaTeX code optimizations to a minimum and\nexplain things *only* at this LaTeX-Q\u0026A meetings! You will see: your\ncolleagues make the same mistakes as you do. And as I have done a\ncouple of years ago.\n\nOccasionally, this LaTeX meetings may be canceled. In this case, I\nwill send an email preferably at least two days in advance.\n\n** LaTeX Code\n\nThis is about the *form* of your thesis.\n\nYou *have* to use the LaTeX typesetting system to write your\nthesis. For millions of reasons there is no arguing for doing it in\nother systems. Sorry for that.\n\nI will keep individual LaTeX code optimizations to a minimum and\nexplain LaTeX-related things *only* at the LaTeX-Q\u0026A meetings!\n\nI assume that you already have [[http://LaTeX.TUGraz.at][basic LaTeX knowledge]].\n\n- Use the LaTeX [[http://latex.tugraz.at/vorlagen/allgemein#laengeres_dokument_wie_diplomarbeit_dissertation_buch][thesis template of LaTeX@TUG]]\n  - you can use your own thesis template as long as you know what you\n    are doing (I will check!)\n  - especially as LaTeX beginner: *never* write your own template or\n    preamble. Trust me. [[http://www.urbandictionary.com/define.php?term%3Dbtdt][BTDT]] :-)\n- In any case: please read the content of the example chapters of [[http://latex.tugraz.at/vorlagen/allgemein#laengeres_dokument_wie_diplomarbeit_dissertation_buch][the\n  LaTeX@TUG template]]!\n- Use the [[http://www.ctan.org/tex-archive/macros/latex/contrib/todonotes/][todonotes]] packet\n  - add the «listoftodos» command in your document to get an overview\n    of open issues\n  - Annotations and suggestions will be done using todonotes snippets\n    within your tex-files\n  - use todonotes by annotating open issues by yourself\n- Check in all necessary files for compilation into the Git repository\n  - do not forget images and such\n  - do use *meaningful submit messages* in the commit line\n- Maintain a script that generates the PDF file completely\n  - the thesis template of LaTeX@TUG offers a [[http://en.wikipedia.org/wiki/Makefile][makefile]] for that\n    purpose\n- Make sure your LaTeX-editor ...\n  - uses a decent *spell checker*\n  - produces UTF-8 compatible TeX-files\n  - does not produce line lengths longer than the usual 70-90\n    characters in your TeX-files\n- Do not check in the PDF output files into the Git repository\n  of your thesis unless we agree on an exception\n  - you can [[https://git-scm.com/docs/gitignore][ignore files for Git]] and thus keep them only for your own\n\nThere is an even longer [[https://github.com/dspinellis/latex-advice][page with excellent tips on how to write LaTeX\ndocuments]]. I recommend you to read it as well. Some details do differ\nfrom your situation here because you are using a different LaTeX\ntemplate (KOMA script) where following things are handled differently:\n- no natbib\n- no doublespace (it's not even maintained any more)\n- no geometry\n- no pslatex\n\n* License\n\n[[https://github.com/novoid/Student-Supervision-Process][Student Supervision Process]] by Karl Voit is licensed under a\n[[http://creativecommons.org/licenses/by-nc-sa/3.0/][Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License]]\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnovoid%2Fstudent-supervision-process","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnovoid%2Fstudent-supervision-process","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnovoid%2Fstudent-supervision-process/lists"}