Sèvi ak GIT lè w ap dokimante

Pafwa pa sèlman dokiman an tèt li, men tou, pwosesis la nan travay sou li ka kritik. Pou egzanp, nan ka a nan pwojè, pati lyon an nan travay la ki gen rapò ak preparasyon an nan dokiman, ak yon pwosesis kòrèk ka mennen nan erè e menm pèt enfòmasyon, epi, kidonk, pèt tan ak benefis yo. Men, menm si sijè sa a pa santral nan travay ou epi li se sou periferik la, pwosesis dwat la ka toujou amelyore kalite dokiman an epi sove tan ou.

Apwòch ki dekri isit la, avèk egzanp yon aplikasyon espesifik, gen yon baryè antre ki ba. Teknikman, ou ka kòmanse travay nan yon nouvo fason demen.

Deklarasyon sou pwoblèm nan

Ou bezwen kreye yon dokiman oswa yon seri dokiman. Petèt sa a se dokiman pwojè oswa antre nan rezo ou a, oswa yon bagay ki pi senp, pou egzanp, ou dwe dekri pwosesis yo nan konpayi an oswa nan depatman ou. An jeneral, nou ap pale de nenpòt dokiman oswa seri dokiman ki gen tèks, foto, siy... Ann konplike travay la pa lefèt ke

1. travay sa a enplike travay ansanm, efò yo nan yon gwoup oswa plizyè gwoup anplwaye yo
2. Kòm yon rezilta, ou vle gen yon dokiman nan yon fòma sèten, ak atribi style antrepriz, ki te kreye dapre yon modèl sèten. Pou nou espesifik, nou pral asime ke sa a se MS Word (.docx)

10 ane de sa apwòch la ta senp: nou ta kreye yon dokiman MS Word oswa dokiman epi yon jan kanmenm òganize travay chanjman an.

Ak apwòch sa a toujou valab. Li se tou itilize pa entegratè gwo lè yo kreye dokiman pwojè. Men, li entwitif klè ke si ou reyèlman travay entansif sou yon dokiman, ak anpil modifikasyon ak diskisyon, sou yon peryòd tan ki long, apwòch sa a pa trè pratik.

Egzanp

Mwen te santi pwoblèm sa a byen grav pandan m ap travay pou yon entegratè gwo. Pwosesis pou chanje dokiman konsepsyon an te jan sa a:

1. enjenyè telechaje dènye vèsyon MS Word (.docx) dokiman an
2. chanje non
3. fè chanjman nan swiv mòd
4. voye dokiman an ak modifikasyon bay achitèk la
5. tou voye yon lis tout koreksyon ak kòmantè
6. achitèk analize chanjman yo
7. si tout byen, li kopye chanjman sa yo nan yon dosye ki gen dènye vèsyon an, chanje vèsyon an, epi telechaje li nan yon resous pataje.
8. si gen kòmantè, yon diskisyon kòmanse (imel oswa reyinyon)
9. konsansis rive
10. plis pwen 3 - 9

Pandan ke travay la pa t 'entans, li te yon jan kanmenm, men li te toujou travay. Men, nan yon sèten pwen, pwosesis sa a te vin bouchon nan tout pwojè a ak mennen nan pwoblèm. Pwen an se ke bagay yo vin move le pli vit ke chanjman yo fè souvan ak ansanm pa plizyè ekip.

Se konsa, lè nou te deplase nan etap tès la preliminè, divès pwoblèm yo te kòmanse parèt epi, byenke nan ti fason, li te nesesè yo chanje dokiman an souvan - kat ekip diferan, chak jou, prèske an menm tan, ak diskisyon. Tout chanjman sa yo te fèt atravè yon enjenyè - yon achitèk. Fichye konsepsyon pwojè a te gwo, e kòm yon rezilta, achitèk la te akable ak travay woutin ki enplike anpil kopi, koreksyon, te fè anpil erè, te oblije tcheke tout bagay, voye l ', e an jeneral li te tou pre. dezòd.

Nan ka sa a, apwòch sa a, apwòch la nan travay sou yon dokiman MS Word, te travay ak anpil difikilte ak kreye pwoblèm.

Git, Markdown

Fè fas ak pwoblèm ki dekri nan egzanp ki anwo a, mwen te kòmanse fè rechèch sou pwoblèm sa a.
Mwen te wè ke itilize nan rediksyon ansanm ak ale lè w ap kreye dokiman yo.

Git se yon zouti devlopman. Men, poukisa pa sèvi ak li pou pwosesis dokimantasyon an? Nan ka sa a, pwoblèm nan nan travay milti-itilizatè vin rezoud. Men, pou nou kapab pwofite anpil nan kapasite Git, nou bezwen yon fòma dokiman tèks, nou bezwen jwenn yon zouti ki pa MS Word, ak Markdown bon pou rezon sa yo.

Markdown se yon senp lang maketing tèks. Li fèt pou kreye tèks trè byen fèt nan dosye TXT regilye. Si nou kreye dokiman nou yo nan Markdown, Lè sa a, konbinezon an Markdown - Git sanble natirèl.

Ak tout bagay ta byen, ak nan pwen sa a nou ta ka mete yon fen nan li, si se pa pou dezyèm kondisyon nou an: "Kòm yon rezilta, nou bezwen yon dokiman nan yon fòma sèten, ak atribi yo nan yon style antrepriz, ki te kreye dapre yon modèl sèten" (e nou te dakò nan kòmansman an ke pou Sètènman li pral MS Word). Sa vle di, si nou deside sèvi ak Markdown, Lè sa a, nou bezwen yon jan kanmenm konvèti fichye sa a nan yon .docx nan kalite ki nesesè yo.

Gen pwogram pou konvèti ant diferan fòma, pa egzanp. pandoc.
Ou ka konvèti dosye Markdown nan fòma .docx ak pwogram sa a.
Men, toujou, ou bezwen konprann ke, premyèman, se pa tout sa ki nan Markdown yo pral konvèti nan MS Word epi, dezyèmman, MS Word se yon peyi antye konpare ak mens, men yo toujou ti vil, Markdown. Gen yon gwo kantite tout bagay ki nan Pawòl ki pa nan nenpòt fòm nan Markdown. Ou pa ka jis ale pi devan epi konvèti fòma Markdown ou a nan fòma MS Word vle lè l sèvi avèk sèten kle Pandoc. Se konsa, anjeneral, apre konvèsyon, ou dwe "edit" dokiman an ki kapab lakòz .docx manyèlman, ki ankò ka pran tan epi mennen nan erè.

Si nou te kapab ekri yon script ki ta otomatikman "fini" sa Pandoc pa t 'kapab jere, sa ta dwe yon solisyon ideyal.

Akòz ki pa idantite nan fonksyonalite MS Word ak Markdown, li enposib rezoud pwoblèm sa a an jeneral, mwen panse, men èske sa ka fè an relasyon ak sitiyasyon espesifik, kondisyon espesifik? Eksperyans mwen te montre ke wi, li posib epi li posib pou anpil, oswa petèt menm pifò sitiyasyon.

Solisyon yon pwoblèm patikilye

Se konsa, nan ka mwen an, apre konvèti fichye a lè l sèvi avèk Pandoc, mwen te oblije manyèlman fè pwosesis adisyonèl dosye, sètadi

• ajoute jaden nan Word ak nimero otomatik nan tit (tit) nan tablo ak foto
• chanje style tab la

Mwen pa jwenn ki jan fè sa lè l sèvi avèk estanda (Pandoc) oswa mwayen li te ye. Se konsa, mwen aplike script la python ak pywin32 pake. Kòm yon rezilta, mwen te resevwa automatisation konplè. Koulye a, mwen ka konvèti dosye Markdown mwen an nan fòm dokiman MS Word vle ak yon sèl kòmand.

Gade detay isit la.

Remak

Nan egzanp sa a, mwen, nan kou, konvèti kèk dosye abstrè Markdown, men egzakteman menm apwòch la te aplike nan dokiman "konba" la, ak pwodiksyon an mwen te resevwa a te prèske egzakteman menm dokiman MS Word ke nou te deja resevwa pa fòma manyèl. .

An jeneral, ak pywin32 nou jwenn kontwòl prèske konplè sou dokiman MS Word la, ki pèmèt nou chanje li epi pote li nan fòm estanda antrepriz ou a mande. Natirèlman, menm objektif yo ta ka reyalize lè l sèvi avèk lòt zouti, pou egzanp, VBA makro, men li te pi bon pou mwen sèvi ak python.

Yon fòmil tou kout pou apwòch sa a:

Markdown + Git -- (нечто) --> MS Word

Li pa gen pwoblèm sa "yon bagay" se. Nan ka mwen an se te Pandoc ak python ak pywin32. Preferans ou ka diferan, men sa ki enpòtan se ke li posib. Ak sa a se mesaj prensipal la nan atik sa a.

Pou rezime, lide a se ke ak apwòch sa a ou travay sèlman ak dosye a Markdown epi sèvi ak Git pou kolaborasyon ak kontwòl vèsyon, epi sèlman lè sa nesesè (pa egzanp, bay dokimantasyon nan kliyan an) otomatikman kreye yon dosye nan fòma vle a ( pou egzanp, MS Word).

pwosesis

Mwen panse ke pou anpil moun, fòmil yo bay pi wo a ase yo konprann ki jan pwosesis la nan travay ak dokiman yo kapab kounye a dwe òganize. Men, toujou, mwen anjeneral konsantre sou enjenyè rezo, kidonk mwen pral montre an tèm jeneral ki jan pwosesis travay la ka sanble kounye a, ak ki jan sa a diferan de apwòch la nan koreksyon dosye MS Word.

Pou nou espesifik, nou pral chwazi GitHub kòm platfòm la pou travay ak Git. Lè sa a, ou ta dwe kreye yon depo epi mete dosye Markdown la oswa dosye ou planifye pou travay avèk yo nan branch mèt la.

Nou pral gade nan yon pwosesis senp ki baze sou "github koule". Ou ka jwenn deskripsyon li yo tou de sou entènèt la ak sou habre.

Ann di gen kat moun k ap travay sou dokiman an epi ou se youn nan yo. Lè sa a, kat branch adisyonèl yo kreye, pou egzanp, ak non yo nan moun sa yo. Tout moun ap travay lokalman, nan pwòp branch pa yo epi fè chanjman ak tout sa ki nesesè kòmandman git.

Lè w fin ranpli kèk moso travay, ou kreye yon demann rale, kidonk kòmanse yon diskisyon sou chanjman ou yo. Petèt, pandan diskisyon an, li sanble ke ou ta dwe ajoute oswa chanje yon lòt bagay. Nan ka sa a, ou fè chanjman ki nesesè yo epi kreye yon demann rale adisyonèl. Evantyèlman, chanjman ou yo aksepte ak fizyone nan branch mèt la (oswa jete).

Natirèlman, sa a se yon deskripsyon jistis jeneral. Pou kreye yon pwosesis detaye, mwen sijere kontakte devlopè ou oswa jwenn moun ki gen konesans. Men, mwen vle sonje ke baryè a antre nan Git se byen ba. Sa a pa vle di ke pwotokòl la se senp, men ou ka kòmanse senp. Si ou pa konnen anyen ditou, mwen panse apre ou fin pase kèk èdtan oswa petèt jou aprann ak enstale, ou ka kòmanse sèvi ak li.

Ki benefis apwòch sa a konpare ak, pa egzanp, pwosesis ki dekri nan egzanp ki anwo a?

An reyalite, pwosesis yo byen sanble, ou jis ranplase

kopye yon fichye -> kreye yon branch
kopye tèks nan dosye final la -> fusion
kopye dènye chanjman yo nan tèt ou -> git pull/fetch
diskisyon nan korespondans -> rale demann
track mode -> git diff
dènye vèsyon apwouve -> branch mèt
backup (kopi sou yon sèvè aleka) -> git push
...

Kidonk, ou otomatize tout sa ou te deja fè, men manyèlman.

Nan yon nivo ki pi wo li pèmèt ou

• kreye yon pwosesis klè, senp ak kontwole pou chanjman dokiman yo
• paske ou kreye dokiman final la (nan egzanp nou an MS Word) otomatikman, sa diminye chans pou erè fòma

Remak

Apre sa, mwen panse ke li evidan ke menm si w ap travay sou dokiman pou kont li, lè l sèvi avèk Git ka fè travay ou pi fasil.

Tout bagay sa a amelyore kalite dokiman an ak diminye tan pou kreyasyon li yo. Ak yon lòt ti bonis - ou pral aprann Git, ki pral ede w lè otomatize rezo ou a :)

Ki jan yo chanje nan yon nouvo pwosesis?

Nan kòmansman atik la, mwen te ekri ke demen ou ka kòmanse travay nan yon nouvo fason. Ki jan yo pran travay ou nan yon nouvo direksyon?

Isit la se sekans etap ou pral gen plis chans bezwen swiv:

• si dokiman ou a gwo anpil, divize l an pati
• konvèti chak pati nan Markdown (itilize Pandoc pou egzanp)
• enstale youn nan editè Markdown yo (mwen itilize Typora)
• gen plis chans w ap oblije ajiste fòma dokiman Markdown ki te kreye yo
• kòmanse aplike pwosesis ki dekri nan chapit anvan an
• an menm tan an, kòmanse modifye script konvèsyon an adapte travay ou a (oswa kreye yon bagay nan pwòp ou a)

Ou pa oblije rete tann jiskaske ou te kreye ak pèfeksyone mekanis konvèsyon Markdwon -> kalite dokiman yo mande yo. Pwen an se ke, menm si ou pa kapab byen vit konplètman otomatize pwosedi a pou konvèti dosye Markdown ou a, ou ka toujou fè li nan kèk fòm lè l sèvi avèk Pandoc ak Lè sa a, pote l 'nan fòm final la manyèlman. Anjeneral ou pa bezwen fè sa souvan, men sèlman nan fen sèten etap, ak travay manyèl sa a, byenke enkonvenyan, toujou, nan opinyon mwen, byen akseptab nan etap debogaj la epi li pa ta dwe "ralanti" pwosesis la. anpil.

Tout lòt bagay (Markdown, Git, Pandoc, Typora) deja pare epi yo pa mande anpil efò oswa tan pou kòmanse travay avèk yo.

Sous: www.habr.com