Document Generation

Generate Tech Documentation

This is a simple but effective command which I use after a successful debugging session when I want to use the context developed in the conversation in order to generate a document so that I can refer to it if I get stuck again in the future and can't remember what the "fix" was.

Some will take issue with the inclusion of "please". I don't believe that being corteous ever hurts - to human or bot!

How To Use

This will quite reliably generate documentation in Markdown that can be directly pasted into Google Docs (etc). Hopefully soon I'll have a Google Drive saving utility up and running which will render this prompt less useful but it's always useful to be able to generate into a direct paste rather than to a platform.

Suggested Command

tech-documentation-generate

Prompt

Thanks for successfully troubleshooting my issue. I would like to create documentation of this so that I can resolve this independently if it happens again. Please generate a summary of this interaction. Make sure to include my presenting problem. And what successfully resolved the issue. Omit any unsuccessful things that we tried. Add today's date. If you don't have it, ask me for it and I will provide. Make sure that code is provided in codefences. Finally, generate the document in markdown and provide it within a codefence. 

List the Commands You Taught Me

Thanks for your help today.

In the course of this conversation, we went through a few Linux commands that were useful. 

I would like to document them for future reference. 

Could you do the folowing:

List every command in a codefence. Preface it by explaining what it does. 

You can omit basic commands like "ls" and "cd". 

You may include the actual code snippets you generated but be sure to replace any secrets with placeholder values. 

Send This To Anyone!

Let's pause here. 

This has been a really helpful conversation. 

It would be really helpful if you could send me a summary of this conversation. I'd like to send it to {{name}} who is {{relationship}}.

Please do the following:

Generate a document. Format it in markdown. Provide it to me within a codefence. 

Start it by greeting {{name}} by name. Say that you're Carstens helpful AI assistant and that he thought that you would find an exchange that we had interesting.

Then:

- Summarise my prompt
- Summarise your responses
- Summarise the conversation