NOTE: To edit or create new pages with existing components, you don't need to
edit the code! Just go to any page and hit Ctrl+Shift+E
to open the editor of
the current page you're seeing.
Start the project:
deno task start
Navigate to https://localhost:8000
to see the admin.
Required DISCORD_LEADS_WEBHOOK_URL
env var to test feature
To add a new docs, change the following files:
toc.ts
to add it to the menu tree.decs/...
to add the new Markdown document
Recommended reading: Google Tech Writing courses.
Here are some key insights from it:
Generated from ChatGPT
- Technical writing fundamentals:
- Know your audience and write for them. Use language and concepts they will understand.
- Define the purpose and scope of your document before you start writing.
- Organize your content in a logical and structured way, using headings, subheadings, and lists.
- Use active voice and concise language to make your writing clear and easy to understand.
- Document design and layout:
- Use typography, color, graphics, and page layout to make your documents visually appealing and easy to read.
- Use white space to break up large blocks of text and make your document easier to skim.
- Use tables, charts, and diagrams to present complex information in a clear and concise way.
- Use consistent formatting throughout your document to make it easier to navigate.
- Writing styles and tone:
- Use a consistent tone throughout your document. Your tone should be professional, but also approachable and engaging.
- Use clear, simple language and avoid jargon or technical terms that your audience may not understand.
- Use active voice to make your writing more engaging and easier to understand.
- Use examples and analogies to make complex concepts more accessible.
- Tools and technology:
- Use tools such as version control and collaboration software to help manage your documents.
- Use templates and style guides to ensure consistency across your documents.
- Use screenshots and screen recordings to demonstrate how to use software or perform specific tasks.
- Use hyperlinks to provide additional information or resources.
- Editing and proofreading:
- Edit and revise your document multiple times to ensure accuracy and clarity.
- Use a checklist to ensure you have covered all the necessary elements in your document.
- Proofread your document carefully to eliminate errors in grammar, spelling, and punctuation.
- Have someone else review your document for feedback and to catch errors you may have missed.