Find a job 
Featured Companies 
Featured Universities 
For Companies At a Glance
- Tasks: Restructure and format technical documentation for a maps-based website.
- Company: Join a dynamic team focused on innovative web solutions.
- Benefits: Flexible hours, remote work, and the chance to enhance your portfolio.
- Why this job: Combine your programming skills with technical writing to make a real impact.
- Qualifications: Experience in JavaScript, TypeScript, and technical documentation is essential.
- Other info: Short-term contract with potential for future opportunities.
The predicted salary is between 2000 - 3000 £ per month.
I have a maps-based website which I am developing documentation for. Most of the information needed is already in, but the documentation requires some significant restructuring and formatting.
I need someone who programs (preferably able to read TypeScript, which the site is written in) and has experience in technical documentation for software. The documentation is currently in TypeScript, with flowcharts in Mermaid. There is no Table of Contents, which you will have to create, as well as do serious editing in some text and reference links between text and diagrams.
This work will require a real documentation professional with a fastidious work ethic. The importance of accuracy is paramount, which is why LLM-based generative AI would do poorly for this work (LLMs consistently generate inaccuracies in documentation, I've found). You will need to be able to examine the functional interface as well as the code to create accurate descriptions.
Although most of the work is done, significant work remains, as mentioned, and you will be required to get into code to be able to complete the task successfully. If you apply to this job, I’ll share more details with you, so you can decide if you are still interested. Please be able to share prior work with software-based documentation you have worked on in the past.
Contract duration of less than 1 month.
Mandatory skills: JavaScript, TypeScript, Technical Documentation, Technical Writing
Need a Technical Writer who is also a programmer for the documentation of a maps-based website employer: FreelanceJobs
Contact Detail:
FreelanceJobs Recruiting Team
StudySmarter Expert Advice 🤫
We think this is how you could land Need a Technical Writer who is also a programmer for the documentation of a maps-based website
✨Tip Number 1
Get your portfolio ready! Make sure you have examples of your technical documentation work handy, especially anything related to software. This will show potential employers that you know your stuff and can deliver quality work.
✨Tip Number 2
Network like a pro! Reach out to people in the industry, join relevant forums, or even connect with others on LinkedIn. You never know who might have a lead on a job that’s perfect for you.
✨Tip Number 3
When you get an interview, be prepared to discuss your coding skills! Since this role requires programming knowledge, brush up on your JavaScript and TypeScript so you can confidently talk about how you can contribute to the project.
✨Tip Number 4
Apply through our website! It’s the best way to ensure your application gets seen by the right people. Plus, we love seeing candidates who take the extra step to engage with us directly.
We think you need these skills to ace Need a Technical Writer who is also a programmer for the documentation of a maps-based website
Some tips for your application 🫡
Show Off Your Skills: Make sure to highlight your programming skills, especially in JavaScript and TypeScript. We want to see how you can blend your technical know-how with your writing prowess, so don’t hold back!
Prior Work is Key: When you apply, include examples of your previous technical documentation work. We’re keen to see how you've tackled similar projects, especially if they involved software or code.
Be Detail-Oriented: Since accuracy is super important for this role, make sure your application is free from typos and errors. We appreciate a fastidious work ethic, so let that shine through in your writing!
Apply Through Our Website: We encourage you to submit your application through our website. It’s the best way for us to keep track of your application and ensure it gets the attention it deserves!
How to prepare for a job interview at FreelanceJobs
✨Know Your Tech Inside Out
Make sure you brush up on your JavaScript and TypeScript skills before the interview. Be ready to discuss how you've used these languages in past projects, especially in relation to technical documentation. This will show that you not only understand the code but can also translate it into clear, concise documentation.
✨Showcase Your Documentation Skills
Prepare examples of your previous work in technical documentation. Highlight any experience you have with restructuring and formatting documents, especially if you've worked with flowcharts or similar tools like Mermaid. This will demonstrate your ability to create user-friendly documentation.
✨Emphasise Attention to Detail
Since accuracy is crucial for this role, be prepared to discuss how you ensure precision in your work. Share specific strategies you use to catch errors and maintain high standards in your documentation. This will reassure them that you're the meticulous professional they're looking for.
✨Ask Insightful Questions
Come prepared with questions about the project and the team. Inquire about their current documentation challenges and how they envision the final product. This shows your genuine interest in the role and helps you gauge if it's the right fit for you.
