Can someone explain the accepted method to upload a word document and make it available to review.

Question

I created a User's reference manual for my design of a programmable logic analysis and stimulus engine "PLASE". I would like to make this document available for review. It is a reasonable functional description of my design and I would like to have some feedback on interest in me uploading the FPGA Verilog design at some point. I am happy to answer any questions that might arise.

cstanton · Accepted Answer

Hi Chazley8871 , 
 Consider writing it as a blog instead of trying to upload a word document. 
 Word documents are not very well trusted because they can contain macro and scripts. If it's the content itself that you'd like to have appraised or looked over by others, instead consider writing it as a blog post in one of the groups ( https://community.element14.com/sitemap ) on the site.

robogary · Answer

Another solution maybe to postyour doc on Github or googledrive, and share the link.

shabaz · Answer

If it's deep reference content, I think you could do a lot worse than converting to Markdown (or HTML) pages, and putting it on GitHub, one file per section or chapter. 
 I don't know about others but at least to me, that approach seems more maintainable than a large PDF if you're working on your own, and it's easier for people to casually browse through it than download a PDF.. and people might even fix your documentation one day, through the collaboration made possible with using GitHub.

Can someone explain the accepted method to upload a word document and make it available to review.

Top Replies