Skip to content

Instantly share code, notes, and snippets.

@MilesDowe
Last active February 23, 2022 16:02
Show Gist options
  • Save MilesDowe/ad6fe9889ad347bddc20e5a456d92c98 to your computer and use it in GitHub Desktop.
Save MilesDowe/ad6fe9889ad347bddc20e5a456d92c98 to your computer and use it in GitHub Desktop.
Vimwiki project board organization ideas

Using vimwiki or wiki.vim, I'm trying to setup some organization boards for projects. Here are some notes on the subject.

Board structure

Below is an example of how I structure individual project boards:

# Ad hoc tasks #

[backlog](./backlog.md) :: Tasks available for grooming
[archive](./archive.md) :: Finished and stale tasks
[notes](./notes.md)     :: Misc. notes and context

## To do ##

## Blocked ##

## In progress ##

[Create Git repository](./6a20c3fc-60c5-4752-a8ec-1db17a182b72.md)

## Done ##

Automatic ticket creation

Below is a remap example that highlights a line, turns it into a link to a new local file, whose name is just a UUID, generated by Ultisnips/vim-snippets. The philosphy of this being that tickets are plentiful and I won't really be navigating by filename ever, only the wiki hyperlinks. This allows me to not be bothered with naming collisions and what to name my files.

" Note the tab character before '.md' is leveraging a plugin to auto-expand the 'uuid' snippet.
nnoremap <leader><leader>k normal ^v$\sa[A(./uuid	.md)<cr>

This can be further enhanced. Maybe prepopulates the new file with the ticket template, etc.

Not all tasks really need to be a ticket. Only tasks that might need specific requirements that aren't self-evident, need additional contextual information, or would benefit from a log of events.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment